SassDoc / sassdoc

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

@!group directive #443

Closed tf closed 8 years ago

tf commented 8 years ago

I think it would be really handy if there was some sort of directive concept to apply an annotation to multiple elements at once. Especially defining groups can be quite repetitive. YARD solves this with the @​group/@​endgroup directives.

pascalduez commented 8 years ago

Hi,

you can achieve this with file-level annotations.

tf commented 8 years ago

But there I can only define one group for all items, right? I think there can be cases where it can make sense to keep multiple groups in the same file.

valeriangalliat commented 8 years ago

Hmm, we would need CDocParser to support "range" annotations (with start and end markers), like for file-level annotations. Then updating CDocParser would automagically make SassDoc work with this syntax.

No even need to think about the multiple flag I guess, because it's exactly like a poster annotation in this regard.

I suggest to open this issue / make a PR on CDocParser. :+1:

tf commented 8 years ago

Interesting. @pascalduez comment made me wonder though if the urge to reach for group ranges is a smell in itself telling me to break apart my files. I'll watch out for this as I go along and open an issue with CDocParser when I have formed a clearer opinion. Thanks for the suggestion!

pascalduez commented 8 years ago

Re-opening to keep track of it, and get @SassDoc/owners feedback on this.

I'm not too keen at the moment, having several ways to perform certain actions might be confusing.

KittyGiraudel commented 8 years ago

Coming back to this, I’ll side with @pascalduez. That seems like unnecessary complexity?

tf commented 8 years ago

Agreed. Splitting things into multiple files is a good idea anyway. I think this, issue should be closed.

pascalduez commented 8 years ago

All right, let's close. We will need to planify a bit the future at some point, especially at the parser level.