action-misspell icon indicating copy to clipboard operation
action-misspell copied to clipboard
verified publisher icon reviewdog

README is misleading

Open NoaHeinrich opened this issue 4 years ago • 1 comments

Because many of the examples in the README are surrounded in brackets, I had believed that the options in the yml file had to be in brackets too. This led to some quiet errors in CI that I did not notice for several weeks. Removing the brackets around examples like 'armor,color' could cut down on confusion.

NoaHeinrich avatar Aug 05 '21 15:08 NoaHeinrich

@NoaHeinrich what wording would you suggest? PRs to improve documentation are usually always welcome 🙂

grische avatar Nov 13 '21 21:11 grische