search

SassDoc / sassdoc

Release the docs!
http://sassdoc.com
MIT License
1.41k stars 56 forks source link

Parse group description #534

Closed xi closed 5 years ago

xi commented 5 years ago

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 commented 5 years ago

Coverage Status

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

xi commented 5 years ago

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.