documentationjs / documentationjs/documentation

Trailing spaces for @returns

Open
#1,219 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

I generally have trailing whitespace removed on save in all my files to prevent irritating diffs like this:
```diff
-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`
```js
...
*
* @returns {Array}
*/
...
```

> `README.md` (spaces replaced by underscores for visibility)
```md
...
Returns_**[Array](..)**_
...
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.