When running checklist::documentation() I got the error Item starts with `* ` or ` * `. Multiline items start with ` `., and I have some suggestions for improvement.
First of all, I had no clue where it was about, so I suggest to mention NEWS.md in the error message, e.g. Item in NEWS.md starts with `* ` or ` * `. Multiline items start with ` `. And maybe even make clear to the user that this is currently not the case: Item in NEWS.md should start with `* ` or ` * `. Multiline items start with ` `.
Second, I am in a situation where I used second level items, in which I used 6 spaces for lines in paragraphs in the second intend, e.g.
* first level text
with some text on the second line
* second level text
with some text on the second line
* and a second item in this second level
also with some text on the second line
But apparently checklist wants me to write it like this:
* first level text
with some text on the second line
* second level text
with some text on the second line
* and a second item in this second level
also with some text on the second line
Personally I prefer the first version, in which I use 6 spaces, over the latter version, where I only used 2 spaces, because if the text is longer (a whole paragraph for each item), it becomes difficult to see the different items on the second level. So I would suggest allowing 6 spaces as well: Item in NEWS.md should start with `* ` or ` * `. Multiline items start with ` ` or ` `.
When running
checklist::documentation()
I got the errorItem starts with `* ` or ` * `. Multiline items start with ` `.
, and I have some suggestions for improvement.First of all, I had no clue where it was about, so I suggest to mention NEWS.md in the error message, e.g.
Item in NEWS.md starts with `* ` or ` * `. Multiline items start with ` `.
And maybe even make clear to the user that this is currently not the case:Item in NEWS.md should start with `* ` or ` * `. Multiline items start with ` `.
Second, I am in a situation where I used second level items, in which I used 6 spaces for lines in paragraphs in the second intend, e.g.
But apparently checklist wants me to write it like this:
Personally I prefer the first version, in which I use 6 spaces, over the latter version, where I only used 2 spaces, because if the text is longer (a whole paragraph for each item), it becomes difficult to see the different items on the second level. So I would suggest allowing 6 spaces as well:
Item in NEWS.md should start with `* ` or ` * `. Multiline items start with ` ` or ` `.