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

New users misunderstand law file help #2

Open
qubitz opened this issue Mar 21, 2021 · 0 comments
Open

New users misunderstand law file help #2

qubitz opened this issue Mar 21, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@qubitz
Copy link
Owner

qubitz commented Mar 21, 2021

New users reading lawyer help law for help in creating a valid law file, don't easily recognize that

...
expected: ^// © ABC Company 1996. All rights reserved.$
...

is the yaml reference rather than the expected contents of the law file.

I believe changing the example into legitimate yaml with yaml comments and line numbers will help distinguish that what is being read is the actual law file.
@qubitz qubitz added the documentation Improvements or additions to documentation label Mar 21, 2021
@qubitz qubitz changed the title New users misunderstand law file New users misunderstand law file help Mar 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@qubitz