Page MenuHomePhabricator
Create Task
Maniphest T218281

Doc for javascript functions needs proper indentation
Closed, ResolvedPublic
Actions

Description

The task "jscs:src" does not fail for the doc comment indentations, but the indention need to be re-arranged.

Actual state

		/**
			* Perform a task.
			*
			* @param {Object} a - a.
			* @return {Object} - Modified a.
			*/

Expected

		/**
		 * Perform a task..
		 *
		 * @param {Object} a - a.
		 * @return {Object} - Modified a.
		 */

Developer Notes

This comprises reducing the indentation from the second line of comment to the last for each doc block.

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Improve indentation of javascript functions docmediawiki/extensions/FormWizardmaster+110 -110
Customize query in gerrit

Related Objects

Event Timeline

Eugene233 created this task.Mar 14 2019, 7:52 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 14 2019, 7:52 AM
Eugene233 added a project: good first task.Mar 14 2019, 7:53 AM
Areefa subscribed.Mar 16 2019, 10:55 AM

Hi, I'd like to work on this if possible, where can i find the link to the file to improve the indentation?
Thanks

Didicodes subscribed.Mar 17 2019, 12:36 PM
Didicodes added a comment.Mar 17 2019, 1:00 PM

@Eugene233 I would also love to work on this.
Kindly include the link to the Javascript documentation.

Mahveotm subscribed.Mar 17 2019, 1:48 PM

@Didicodes, you can find the extension page here.

Didicodes added a comment.Mar 17 2019, 1:50 PM

Thank you @Mahveotm

Aklapper added a comment.Mar 17 2019, 1:57 PM

The FormWizard link goes to https://phabricator.wikimedia.org/project/profile/1496/ which says this tag is about a gadget. It links to https://meta.wikimedia.org/wiki/Meta:FormWizard . It does not link to https://www.mediawiki.org/wiki/Extension:FormWizard (an extension). This is super confusing to me.

Eugene233 added a comment.Mar 17 2019, 10:01 PM
In T218281#5030568, @Aklapper wrote:

The FormWizard link goes to https://phabricator.wikimedia.org/project/profile/1496/ which says this tag is about a gadget. It links to https://meta.wikimedia.org/wiki/Meta:FormWizard . It does not link to https://www.mediawiki.org/wiki/Extension:FormWizard (an extension). This is super confusing to me.

Thanks very much @Aklapper, this needs to be modified...

Eugene233 added a comment.Mar 17 2019, 10:02 PM

Thanks @Mahveotm for pointing @Didicodes and @Areefa to the correct resource. Please feel free to poke me on irc if you have any issues.

Didicodes added a comment.Mar 17 2019, 10:25 PM

Hello, @Eugene233 is this your IRC nickname eugene23?

gerritbot subscribed.Mar 18 2019, 1:16 PM

Change 497295 had a related patch set uploaded (by Didicodes; owner: Didicodes):
[mediawiki/extensions/FormWizard@master] Improved indentation of javascript functions doc

https://gerrit.wikimedia.org/r/497295

gerritbot added a project: Patch-For-Review.Mar 18 2019, 1:16 PM
Didicodes mentioned this in rEFWZ2df69083700d: Improved indentation of javascript functions doc.Mar 18 2019, 1:22 PM
Didicodes claimed this task.Mar 18 2019, 1:28 PM
jijiki mentioned this in rEFWZf3a271ea4193: Improved indentation of javascript functions doc.Mar 18 2019, 4:29 PM
Didicodes mentioned this in T217966: Proposal: Improving ~20 documentation pages to help MediaWiki users to gain mastery of the value and usage of the Mediawiki Action API - Outreachy 18.Mar 19 2019, 10:09 AM
xSavitar moved this task from Backlog to Tasks in progress (Doing) on the Africa-Wikimedia-Developers board.Mar 19 2019, 10:21 AM
gerritbot added a comment.Mar 20 2019, 9:55 AM

Change 497295 had a related patch set uploaded (by D3r1ck01; owner: Didicodes):
[mediawiki/extensions/FormWizard@master] Improve indentation of javascript functions doc

https://gerrit.wikimedia.org/r/497295

Anyijonathan subscribed.Mar 20 2019, 11:10 AM

went through the files, it appears the doc comment are all properly indented.
why am i still getting a mail related to this task?

Aklapper added a comment.Mar 20 2019, 11:51 AM
In T218281#5039587, @Anyijonathan wrote:

why am i still getting a mail related to this task?

??? What do you mean?

Eugene233 added a comment.Mar 20 2019, 12:06 PM

@Aklapper I think @Anyijonathan forgot to unsubscribe from the task. :)

Didicodes added a subscriber: xSavitar.Mar 20 2019, 12:20 PM

Hello, @Eugene233 Kindly review the patch here. @D3r1ck01 has already reviewed it, but you still have to review it before it can be merged. Thanks!

Anyijonathan added a comment.Mar 20 2019, 4:09 PM

yep @Eugene233, i thought i did @Aklapper

Anyijonathan unsubscribed.Mar 20 2019, 4:09 PM
Eugene233 closed this task as Resolved.Mar 20 2019, 4:41 PM

@Didicodes Thanks for working on this and @D3r1ck01 & @Aklapper for assisting. Marking this as resolved.

gerritbot added a comment.Mar 20 2019, 4:42 PM

Change 497295 merged by jenkins-bot:
[mediawiki/extensions/FormWizard@master] Improve indentation of javascript functions doc

https://gerrit.wikimedia.org/r/497295

xSavitar mentioned this in rEFWZ42bd27e60142: Improve indentation of javascript functions doc.Mar 21 2019, 12:26 AM
xSavitar moved this task from Tasks in progress (Doing) to Technical Tasks (Completed) on the Africa-Wikimedia-Developers board.Apr 1 2019, 10:56 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