Opened on 05/17/2018 at 06:45:28 AM
Closed on 08/29/2019 at 05:43:52 PM
#6676 closed change (rejected)
Fix inconsistencies in JSDoc style
Reported by: | mjethani | Assignee: | |
---|---|---|---|
Priority: | P4 | Milestone: | |
Module: | Core | Keywords: | closed-in-favor-of-gitlab |
Cc: | kzar, sergz | Blocked By: | |
Blocking: | Platform: | Unknown / Cross platform | |
Ready: | yes | Confidential: | no |
Tester: | Unknown | Verified working: | no |
Review URL(s): |
Description
Background
The JSDoc comments in adblockpluscore contain a number of inconsistencies in style:
- The "summary" (first sentence) of the comment for a variable, function, or class ends in a period in some but not all instances
- In some instances the comments use the Array.<type> syntax while in others they use the type[] syntax
- @return vs. @returns
- Objects are usually denoted as {Object} but occasionally as {object}
- Nullables (optionals) are not always marked with ? (@type) or [] (@param)
There may be more inconsistencies.
What to change
Fix any inconsistencies (and inconsistencies only!) in JSDoc style. This includes inconsistencies in the way types are denoted and the JSDoc keywords that are used (e.g. @return vs. @returns), obvious (objective) punctuation inconsistencies like summaries ending in periods, inconsistencies in terms used to refer to things (e.g. if it's "element hiding emulation filter" then it should be called the same in all places, not occasionally "emulation hiding filter"), and so on.
Do not make "improvements" to the actual content of the comments and what they convey as part of this issue.
Attachments (0)
Change History (3)
comment:1 Changed on 05/17/2018 at 06:48:05 AM by mjethani
- Owner set to mjethani
comment:2 Changed on 08/15/2018 at 08:08:53 AM by mjethani
- Owner mjethani deleted
comment:3 Changed on 08/29/2019 at 05:43:52 PM by sebastian
- Keywords closed-in-favor-of-gitlab added
- Resolution set to rejected
- Status changed from new to closed
Sorry, but we switched to GitLab. If this issue is still relevant, please file it again in the new issue tracker.
I'll take this up.