Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README is misleading #33

Open
NoaHeinrich opened this issue Aug 5, 2021 · 1 comment
Open

README is misleading #33

NoaHeinrich opened this issue Aug 5, 2021 · 1 comment

Comments

@NoaHeinrich
Copy link

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.
@grische
Copy link

grische commented Nov 13, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@grische @NoaHeinrich