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

Document Usage #12

Open
eseglem opened this issue Mar 20, 2023 · 1 comment
Open

Document Usage #12

eseglem opened this issue Mar 20, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@eseglem
Copy link
Owner

eseglem commented Mar 20, 2023

Currently the only way to determine usage is looking at the tests.

  • Include explanations about the extensive usage of __root__ throughout the models.
  • Explain cases where the grammar can parse, but not transform. Such as bad dates.
  • Explain cases where the pydantic model may output bad text. Such as weird characters.
@eseglem eseglem added the documentation Improvements or additions to documentation label Mar 20, 2023
@jp-u
Copy link

jp-u commented Jun 4, 2024

I would love some usage examples. Trying to figure it out from the tests is a bit challenging.
Thanks for your work!

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
2 participants
@eseglem @jp-u