Page MenuHomePhabricator
Create Task
Maniphest T236706

62: Add jsdoc comments
Closed, ResolvedPublic
Actions

Description

Should better document functions

Related Objects
Search...

StatusSubtypeAssignedTask
 DeclinedDannyS712T236632 [Tracking] Newsletter
 ResolvedDannyS712T239450 84: Newsletter, issue #4
 ResolvedDannyS712T236706 62: Add jsdoc comments

Event Timeline

DannyS712 created this task.Oct 28 2019, 4:26 PM
Restricted Application assigned this task to DannyS712. · View Herald TranscriptOct 28 2019, 4:26 PM
Restricted Application added a project: User-DannyS712. · View Herald Transcript
DannyS712 triaged this task as High priority.Oct 28 2019, 4:26 PM
DannyS712 moved this task from Backlog to Ready for development on the DannyS712-Global_watchlist.js board.
Maintenance_bot moved this task from Unsorted to Global Watchlist on the User-DannyS712 board.Oct 28 2019, 5:15 PM
DannyS712 closed this task as Declined.Nov 16 2019, 5:59 AM
DannyS712 moved this task from Ready for development to Archive on the DannyS712-Global_watchlist.js board.

Started doing this - not much benefit (since I'm the primary person who needs to be able to understand the functions) and creates file bloat -> not doing

Masumrezarock100 subscribed.Nov 16 2019, 8:12 AM
In T236706#5668680, @DannyS712 wrote:

Started doing this - not much benefit (since I'm the primary person who needs to be able to understand the functions) and creates file bloat -> not doing

It would be helpful to those who wants to contribute to your script per T238298.

DannyS712 added a comment.Nov 17 2019, 1:35 AM
In T236706#5668751, @Masumrezarock100 wrote:
In T236706#5668680, @DannyS712 wrote:

Started doing this - not much benefit (since I'm the primary person who needs to be able to understand the functions) and creates file bloat -> not doing

It would be helpful to those who wants to contribute to your script per T238298.

I'll probably migrate development elsewhere at some point, and then add the documentation there.

DannyS712 reopened this task as Open.Dec 15 2019, 12:08 AM
DannyS712 moved this task from Archive to Ready for development on the DannyS712-Global_watchlist.js board.

@Masumrezarock100 on second thought...

DannyS712 renamed this task from 62: Add jsdoc comments to 62: Add jsduck comments.Dec 15 2019, 12:12 AM

Per https://www.mediawiki.org/wiki/Manual:Coding_conventions/JavaScript#Documentation

DannyS712 renamed this task from 62: Add jsduck comments to 62: Add jsdoc comments.Dec 15 2019, 12:13 AM

Actually, per T138401: Replace jsduck with JSDoc3 across all Wikimedia code bases

DannyS712 closed this task as Resolved.Dec 15 2019, 1:29 AM

Done in 6.11.0

DannyS712 added a parent task: T239450: 84: Newsletter, issue #4.Dec 15 2019, 4:24 AM
DannyS712 moved this task from Ready for development to Done (7.0) on the DannyS712-Global_watchlist.js board.
DannyS712 mentioned this in T241482: 91: Figure out generating jsdoc.Dec 27 2019, 11:44 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits