More on RDoc formatting #4027
Closed
More on RDoc formatting #4027
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
jeremyevans
approved these changes
Jan 5, 2021
BurdetteLamar
commented
Jan 6, 2021
stomar
reviewed
Jan 6, 2021
doc/method_documentation.rdoc
Outdated
| A code block should be preceded and followed by a blank line. | ||
| This is unnecessary for the HTML output, but helps in the ri output. | ||
|
|
||
| Consider whether <tt>=> ...</tt> in successive lines should be aligned. |
There was a problem hiding this comment.
Suggested change
| Consider whether <tt>=> ...</tt> in successive lines should be aligned. | |
| Consider whether comments (e. g. <tt># => ...</tt>) in successive lines should be aligned. |
There was a problem hiding this comment.
Have changed to "Consider whether # => ... in successive codeblock lines should be aligned."
|
I have an approval from @jeremyevans, and so propose th squash and merge. Any further improvements can be in a new PR. |
|
Just to clarify the earlier discussion, I did not / do not suggest to everywhere replace string, array, hash with linked class names for those well-known core classes. And, unrelated, too intrusive link layout could be fixed by using a less intrusive styling. |
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.
@stomar is commenting along these lines in current documentation PRs, so let's get things settled in our guidance.