https://bugzilla.wikimedia.org/show_bug.cgi?id=51650
Web browser: ---
Bug ID: 51650
Summary: VisualEditor: Remove (and stop adding) useless
documentation
Product: VisualEditor
Version: unspecified
Hardware: All
OS: All
Status: NEW
Severity: normal
Priority: Unprioritized
Component: Technical Debt
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected], [email protected],
[email protected], [email protected]
Classification: Unclassified
Mobile Platform: ---
/**
* Creates an ve.Element object.
*
* @class
* @abstract
*
* @constructor
*/
ve.Element = function VeElement
These and everything like are useless (not really explaining anything) and
annoying (gets you excited to see a line of text only to find out its nothing)
and makes the jsduck --nodoc utility unusable since a lot of things without
documentation aren't without documentation.
So, henceforth, it is "okay" for a doc block to be just tags with no
description on top (or even just /** */ with nothing, which is all jsduck needs
to include a property in its index).
I (or someone else) will be ridding these at some point, but lets try and not
duplicate them more (I won't take "consistency" as an argument here when
creating something that is like something else that has a useless description,
fill it in or don't copy it, don't spread the virus).
Thanks
--
You are receiving this mail because:
You are on the CC list for the bug.
_______________________________________________
Wikibugs-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l
