Skip to content

Parse group description - #534

Merged
pascalduez merged 5 commits into
SassDoc:masterfrom
xi:feature/group-description
Apr 10, 2019
Merged

Parse group description#534
pascalduez merged 5 commits into
SassDoc:masterfrom
xi:feature/group-description

Conversation

@xi

@xi xi commented Jan 8, 2019

Copy link
Copy Markdown
Contributor

Fixes #520

@pascalduez had proposed to use an object for group instead of adding the groupDescriptions key. However, I found that to many places rely on the fact that group is a string, so I think this is less invasive.

@coveralls

coveralls commented Jan 8, 2019

Copy link
Copy Markdown

Coverage Status

Coverage increased (+0.05%) to 94.727% when pulling 2b3ec76 on xi:feature/group-description into a544986 on SassDoc:master.

@pascalduez pascalduez left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
////

@xi

xi commented Mar 11, 2019

Copy link
Copy Markdown
Contributor Author

I expanded the test. I realized that I had to add a file under annotations/ to make it work. Not sure if this is really the best approach.

/// @group name description

It results in a group with name "name description". I did not want to change this for backwards compatibility.

return {
name: 'groupDescriptions',
}
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@pascalduez pascalduez left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pascalduez
pascalduez merged commit 5a27213 into SassDoc:master Apr 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants