Add support for 'Raises' lines in TomDoc parser #611
Merged
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
aycabta
suggested changes
May 6, 2018
* For the special case of 'initialize', handle 'Raises' as the indicator of the Returns section. * Stop treating Raises lines as multine text and let them be their own paragraphs
|
The commit message should be fixed at 54f6e5b. |
aycabta
approved these changes
May 8, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
indicator of the Returns section.
their own paragraphs
According to my interpretation of the TomDoc spec (http://tomdoc.org/), 'Raises' lines are part of the Returns section. The current RDoc TomDoc parser doesn't recognize these lines and treats them as just continuations of an preceding 'Returns' line. Additionally, constructors (#initialize methods) can be documented without a 'Returns' line, but if there's a 'Raises' line it would mean there is a Returns section. This pull request addresses both of these quirks.