Restore jsdoc tags for storybook documentation
Categories
(Thunderbird :: General, defect)
Tracking
(thunderbird_esr128 unaffected, thunderbird135 unaffected, thunderbird136 unaffected, thunderbird137 fixed)
| Tracking | Status | |
|---|---|---|
| thunderbird_esr128 | --- | unaffected |
| thunderbird135 | --- | unaffected |
| thunderbird136 | --- | unaffected |
| thunderbird137 | --- | fixed |
People
(Reporter: freaktechnik, Assigned: freaktechnik)
References
(Regression)
Details
(Keywords: regression)
Attachments
(1 file)
When rolling out jsdoc rules across the tree, some tags used for documentation in storybook were removed. To restore them, we can add exceptions for those tags to the specific jsdoc rule.
|
Assignee | |
Comment 1•8 days ago
|
||
|
|
Assignee | |
Updated•8 days ago
|
Pushed by heather@thunderbird.net:
https://hg.mozilla.org/comm-central/rev/4ed6f67e6374
Restore jsdoc tags for storybook documentation. r=aleca
|
||
Comment 3•6 days ago
|
||
Thanks for fixing! Where is it documented how these special tags are to be used?
|
|
Assignee | |
Comment 4•6 days ago
|
||
(In reply to Magnus Melin [:mkmelin] from comment #3)
Where is it documented how these special tags are to be used?
https://source-docs.thunderbird.net/en/latest/frontend/custom_element_conventions.html (and https://custom-elements-manifest.open-wc.org/analyzer/getting-started/#supported-jsdoc where it links to). I realize now we should probably document the subset we actually allow and possibly also enhance the tag preferring rule to suggest the forms we use (so cssprop -> cssproperty).
Description
•