Improve CONTRIBUTING.rdoc #1358
Open
+30
−30
Conversation
This file contains hidden or 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 fixes some trivial mistakes in the CONTRIBUTING document without changing the content largely. - Fix typos - Add commas for readability - Fix grammar mistakes - Fix broken links - Use monospace font where necessary
ybiquitous
commented
May 3, 2025
| parsing class must respond to \::parse and accept a String argument containing | ||
| the markup format. An RDoc::Document containing documentation items | ||
| parsing class must respond to +::parse+ and accept a String argument containing | ||
| the markup format. An RDoc::Markup::Document containing documentation items |
There was a problem hiding this comment.
[note] RDoc::Document doesn't exist now. I probably RDoc::Markup::Document is correct.
| the markup format. An RDoc::Document containing documentation items | ||
| parsing class must respond to +::parse+ and accept a String argument containing | ||
| the markup format. An RDoc::Markup::Document containing documentation items | ||
| (RDoc::Markup::Heading, RDoc::Markup::Paragraph, RDoc::Markup::Verbatim, etc.) |
There was a problem hiding this comment.
[note] RDoc::Markup::Heading exists but isn't rendered as a link in HTML. This seems like a bug, but I'm not sure about the details. 🤔
rdoc/lib/rdoc/markup/heading.rb
Line 5 in fdaa5a6
|
One failure on CI is caused by the Ruby installation. It seems like a temporary issue (re-run can recover?). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 fixes some trivial mistakes in the CONTRIBUTING document without changing the content largely.
+or<tt>) where necessaryThe current published page: https://ruby.github.io/rdoc/CONTRIBUTING_rdoc.html