Question: “Must be new lines between each section” is ambiguous
wooorm opened this issue · 5 comments
wooorm commented
In the spec, the requirements section contains the line: “Must be new lines between each section”.
I perceive that as ambiguous, is this ok? (new lines)
# standard-readme
## Install
```sh
npm install some-thing
```
## Usage
```sh
some = require('some-thing')
some.thing()
```
Or this? (blank lines)
# standard-readme
## Install
```sh
npm install some-thing
```
## Usage
```sh
some = require('some-thing')
some.thing()
```
Or? (blank lines between blocks)
# standard-readme
## Install
```sh
npm install some-thing
```
## Usage
```sh
some = require('some-thing')
some.thing()
```
Or even? (blank lines between blocks, double between sections)
# standard-readme
## Install
```sh
npm install some-thing
```
## Usage
```sh
some = require('some-thing')
some.thing()
```
...and finally: should the spec be unambiguous in this case?
RichardLitt commented
Frankly, I'm not sure that new lines is needed - that's a markdown thing, not a spec thing. It shouldn't matter. I'd prefer blank lines between blocks (double blank lines is unnecessary), but the first and second example should also be valid.
wooorm commented
Should we drop it from the spec then?
RichardLitt commented
Makes sense to me. I can PR that.
wooorm commented
Sure, or I could do it too!
RichardLitt commented
Removed that line. :)