Fix display of section comments - #373
Open
jmalcic wants to merge 4 commits into
Open
Conversation
❌ Deploy Preview for sdoc failed.
|
(cherry picked from commit 8349301)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 PR addresses an issue resulting from RDoc having changed where comments are stored in sections (since ruby/rdoc@4b50423 as an array at
RDoc::Context::Section#comments) without removing the old reader. This can make it seem like#commentis still available as with other RDoc objects, when in reality for sections it now never has a value. This then means#descriptiondoesn't work for sections, because it calls the old reader. I couldn't find any tests in the RDoc repo suggesting how#commentsis supposed to be formatted, so this was just a guess