Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add home page link to output message #1165

Merged
merged 1 commit into from
Sep 27, 2024
Merged

Add home page link to output message #1165

merged 1 commit into from
Sep 27, 2024

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Aug 27, 2024

The link is clickable in the terminal and opens the home page in the browser:

Screenshot 2024-08-27 at 23 12 47

This will make it easier for users to visit the generated document.

@st0012
Add home page link to output message
2a513b6 
The link is clickable in the terminal and opens the home page in the browser
colby-swandale
colby-swandale approved these changes Sep 25, 2024
View reviewed changes
Copy link
Member

@colby-swandale colby-swandale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is good, but I wonder if there is a way to add a test for this?

@st0012
Copy link
Member Author

st0012 commented Sep 25, 2024

Currently there is no tests covering RDoc#generate (which can be verified by adding a raise in it and still see all tests pass). If we were to add one, it'll require a new set of test infra to properly assert and clean up generated files.
It'll definitely be a good thing to have as it'll enable true end-to-end testing for RDoc. But considering our current capacity, I'd like to prioritize other improvements first (e.g. #1176)

@colby-swandale
Copy link
Member

colby-swandale commented Sep 26, 2024 •
edited
Loading

Sounds good @st0012 ! Would you be able to open an issue or maybe a project with a ticket to make sure we don't forget?

@st0012
Copy link
Member Author

st0012 commented Sep 27, 2024

@colby-swandale opened #1180

@st0012 st0012 merged commit b7d580a into master Sep 27, 2024
51 checks passed
@st0012 st0012 deleted the add-home-page-link-to-output-message branch September 27, 2024 13:58
matzbot pushed a commit to ruby/ruby that referenced this pull request Sep 27, 2024
@st0012 @matzbot
[ruby/rdoc] Add home page link to output message
098649b 
(ruby/rdoc#1165)

The link is clickable in the terminal and opens the home page in the browser

ruby/rdoc@b7d580afab
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@colby-swandale colby-swandale colby-swandale approved these changes

Assignees
No one assigned
Labels
enhancement
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@st0012 @colby-swandale