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

More on auto-link #9907

Merged
merged 6 commits into from
Feb 12, 2024
Merged

More on auto-link #9907

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
92cc4f0
More on auto-link
BurdetteLamar Feb 9, 2024
9f40073
More on auto-link
BurdetteLamar Feb 9, 2024
ad83c22
More on auto-link
BurdetteLamar Feb 9, 2024
0b5b84c
More on auto-link
BurdetteLamar Feb 10, 2024
0489645
More on auto-link
BurdetteLamar Feb 10, 2024
15cd49b
More on auto-link
BurdetteLamar Feb 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 1 addition & 5 deletions doc/contributing/documentation_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,10 @@ Code that is a simple string should include the quote marks.
In general, \RDoc's auto-linking should not be suppressed.
For example, we should write `Array`, not `\Array`.

We might consider whether to suppress when:
Suppress when:

- The word in question does not refer to a Ruby entity
(e.g., some uses of _Class_ or _English_).
- The reference is to the current class document
(e.g., _Array_ in the documentation for class `Array`).
- The same reference is repeated many times
(e.g., _RDoc_ on this page).
- The reference is to a class or module that users
usually don't deal with, including these:
Copy link
Contributor

Choose a reason for hiding this comment

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

I recommend removing the last bullet as well. It mentions Class, Module, and Method. First, I'm not sure users don't usually deal with them. Second, even if they don't usually deal with them, there is no problem auto-linking when referring to the Ruby class/entity.

I think the only time auto-linking should be supressed is if the usage does not refer to the Ruby class/entity. Maybe:

In general, \RDoc's auto-linking should not be suppressed.
For example, we should write `Array`, not `\Array`.
However, suppress when the word in question does not refer to the Ruby entity
(e.g., some uses of _Class_ or _English_).

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.


Expand Down