Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parse group description #534

Merged
merged 5 commits into from Apr 10, 2019

Conversation

Projects
None yet
3 participants
@xi
Copy link
Contributor

commented Jan 8, 2019

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

This comment has been minimized.

Copy link

commented Jan 8, 2019

Coverage Status

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

@pascalduez
Copy link
Member

left a 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
////
@xi

This comment has been minimized.

Copy link
Contributor Author

commented Mar 11, 2019

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',
}
}

This comment has been minimized.

Copy link
@pascalduez

pascalduez Apr 7, 2019

Member

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.

@xi xi force-pushed the xi:feature/group-description branch from 2c360ad to 2b3ec76 Apr 9, 2019

@pascalduez
Copy link
Member

left a comment

Thanks!

@pascalduez pascalduez merged commit 5a27213 into SassDoc:master Apr 10, 2019

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage increased (+0.05%) to 94.727%
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.