documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Trailing spaces for @returns

Open c-vetter opened this issue 6 years ago • 0 comments

I generally have trailing whitespace removed on save in all my files to prevent irritating diffs like this:

-Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)**
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** 

The difference is in the trailing space, which is hard to catch and unnecessarily bloats the diff.

Would be nice, not to have that 🙂

  • What version of documentation.js are you using?:

    • version 9.3.1
  • How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):

    • CLI: npx documentation readme --section API index.js

index.js

...
 *
 * @returns {Array}
 */
...

README.md (spaces replaced by underscores for visibility)

...
Returns_**[Array](..)**_
...

c-vetter avatar Mar 13 '19 07:03 c-vetter