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.

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

[DOC] Improve links to labels in string.c and struct.c #5531

Merged
merged 1 commit into from
Feb 6, 2022
Merged

[DOC] Improve links to labels in string.c and struct.c #5531

merged 1 commit into from
Feb 6, 2022

Conversation

BurdetteLamar
Copy link
Member

Use RDoc @ notation instead of html reference.

@BurdetteLamar BurdetteLamar added the Documentation Improvements to documentation. label Feb 6, 2022
Copy link
Member

@nobu nobu left a comment

Choose a reason for hiding this comment

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

There are many other #class- and #module- links in these two files.

@peterzhu2118
Copy link
Member

I did a global find and replace in #5530 (see commits 9bbb6d7 and 615eeee).

@BurdetteLamar
Copy link
Member Author

There are many other #class- and #module- links in these two files.

I was wanting to get rid of some of the worst offenders -- those citing .html.

@BurdetteLamar BurdetteLamar merged commit a07fa19 into ruby:master Feb 6, 2022
@zverok
Copy link
Contributor

zverok commented Feb 7, 2022

@BurdetteLamar @nobu Sorry for jumping in late (I was traveling for last few days, and expected to have more time to participate, but I haven't, so sorry for postponing some reviews!).

Previous version rendered like this:
image
The new one (at least when I am trying it locally), does this:
image

I believe it became less readable as a phrase. Don't you agree?..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements to documentation.
4 participants