Fix duplicated description for R6 classes with methods#1823
Merged
Conversation
The first bug arises because `parse_description()` thinks the method `@description` belongs to the class, so the second line of text becomes the details. There's no easy way to change this without significant changes to the parser, so the simplest approach seems to be to patch it up after the fact. The second bug arises about because we were adding the default title twice. Fixes #1504
gaborcsardi
approved these changes
Mar 19, 2026
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
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.
The first bug arises because
parse_description()thinks the method@descriptionbelongs to the class, so the second line of text becomes the details. There's no easy way to change this without significant changes to the parser, so the simplest approach seems to be to patch it up after the fact.The second bug arises about because we were adding the default title twice.
Fixes #1504