Jump to content

Topic on Manual talk:Coding conventions/Flow

[JS] Docblocks: line break between description and tags

2
Novem Linguae (talkcontribs)

I found another area of divergence between phpcs and eslint. Something like...

	/**
	 * Get the IDs of applicable PageTriage namespaces.
	 * @param Config|null $config
	 * @return int[]
	 */

...would be fine in phpcs, but would give a warning for not having a line break before @param and be autofixed in eslint (by the rule jsdoc/tag-lines). Should we make it so these two rules are in alignment? I have no opinion about which style we pick, but I do think it'd be a good idea to keep PHP and JS rules consistent with each other.

Jdforrester (WMF) (talkcontribs)

I believe that we aren't able to enforce this convention in PHPCS which is why it's not yet been done.

Reply to "[JS] Docblocks: line break between description and tags"