Parse group description - #534
Merged
Merged
Conversation
This was referenced Jan 8, 2019
pascalduez
requested changes
Mar 10, 2019
pascalduez
left a comment
Member
There was a problem hiding this comment.
This will need more testing.
You went with the white-space version finally.
What happens when used as follow:
/// @group name description
////
/// This is a poster comment.
/// @group name
/// A group description
/// @author Hugo Giraudel
////
Contributor
Author
|
I expanded the test. I realized that I had to add a file under
It results in a group with name "name description". I did not want to change this for backwards compatibility. |
pascalduez
reviewed
Apr 7, 2019
| return { | ||
| name: 'groupDescriptions', | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
Could you please just add a comment in here explaining why it was added, and that it's not a real annotation etc. basically we shouldn't add it, but I don't want to delay your feature further, our tests will need a good refactor anyway.
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
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.
Fixes #520
@pascalduez had proposed to use an object for
groupinstead of adding thegroupDescriptionskey. However, I found that to many places rely on the fact thatgroupis a string, so I think this is less invasive.