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

clarification to readme #127

Open
pfeifferj opened this issue Feb 3, 2022 · 0 comments
Open

clarification to readme #127

pfeifferj opened this issue Feb 3, 2022 · 0 comments
Labels
bug 🐛 An issue with the system

Comments

@pfeifferj
Copy link

Describe the Bug

The usage section says

The table below correctly indicates which inputs are required.

This is a bit misleading as the example right underneath this text includes non-required inputs. Adding a link to the relevant section to "The table below" would make this clearer.

I tried to make the change myself and open an MR, however it seems the readme was manually edited -- instead of editing the README.yaml and using the build-harness
@pfeifferj pfeifferj added the bug 🐛 An issue with the system label Feb 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug 🐛 An issue with the system
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pfeifferj