馃敆 Remove RDoc auto-link from Rails module everywhere #48563
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rails-bot
bot
added
actioncable
actionmailbox
actionmailer
actionpack
actiontext
actionview
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch was sitting half-baked on my machine, so I decided to just finish it and remove these links which could be confusing to readers who end up on the
Railsmodule not knowing it's purpose.There are other similar namespaces that I'd like to to the same, but I wonder if there is a way to prevent auto-linking for a deny-listed set of modules with SDoc.
Just to name a few that I spotted when doing this.
Realizing this is a cosmetic change, but the value of potentially saving an early developer time possibly wasted on reading the
Railsmodule is worth it IMO. And also using this as an opportunity to let others know about the remaining namespaces that could use the same treatment. 馃檹