inbo / checklist

An R package for checking R packages and R code
https://inbo.github.io/checklist
GNU General Public License v3.0
16 stars 2 forks source link

Error: Item starts with `* ` or ` * `. Multiline items start with ` #101

Closed ElsLommelen closed 1 year ago

ElsLommelen commented 1 year ago

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 ` `.

ElsLommelen commented 1 year ago

Oups, just ignore this one, I noticed you solved this already in the development version, after an earlier note of me. (issue #91)