You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently and from a strictly technical point of view, all annotations can appear multiple times on an item. That being said, it is wrong from a practical standpoint. Some annotations should not appear several times, for instance @type on variables, or @return on functions, only to name a few.
@FWeinb suggests we add a multiple boolean option on each annotation. This way, annotations would not always be arrays. They would be arrays if they allow multiple occurrences (i.e. multiple: true), else it would be a standalone value.
For know this is only in rc1 to be able to fix bugs in scss-comment-parser before we release SassDoc 2.0.
We should make a list of annotations that can only be used once per comment.
Currently and from a strictly technical point of view, all annotations can appear multiple times on an item. That being said, it is wrong from a practical standpoint. Some annotations should not appear several times, for instance
@type
on variables, or@return
on functions, only to name a few.@FWeinb suggests we add a
multiple
boolean option on each annotation. This way, annotations would not always be arrays. They would be arrays if they allow multiple occurrences (i.e.multiple: true
), else it would be a standalone value.This would solve issue like:
... which is ugly as fuck.
This would trigger breaking changes, so it's either 2.0, or never (well, 3.0...).
Edit: this will lead to a new terminology "collection annotations" and "single annotations". I like it.
The text was updated successfully, but these errors were encountered: