Mention RubyDoc page in README #490
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
This gem's methods are documented with RubyDoc-compliant code comments. There is already a [RubyDoc page][] generated from these comments, but it isn't mentioned prominently. Since this gem's isn't covered at length in the Turbo Handbook, the RubyDoc pages are less challenging to read and navigate than the application's source code. This commit mentions the page and links to it from the README. [RubyDoc page]: https://rubydoc.info/github/hotwired/turbo-rails/main
|
@afcapel @kevinmcconnell are you able to review this change? |
|
Thanks @seanpdoyle 🙏 |
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 gem's methods are documented with RubyDoc-compliant code comments. There is already a RubyDoc page generated from these comments, but it isn't mentioned prominently.
Since this gem's isn't covered at length in the Turbo Handbook, the RubyDoc pages are less challenging to read and navigate than the application's source code.
This commit mentions the page and links to it from the README.