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.

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

Documentation + Tutorial #57

Open
neunenak opened this issue Dec 9, 2024 · 3 comments
Open

Documentation + Tutorial #57

neunenak opened this issue Dec 9, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@neunenak
Copy link

neunenak commented Dec 9, 2024

Please add a documentation page explaining what parsing functionality exists within this library.

A basic tutorial about how to get started writing a simple-but-complete parser from scratch would also be helpful.

@fgdorais fgdorais self-assigned this Dec 9, 2024
@fgdorais
Copy link
Owner

fgdorais commented Dec 9, 2024

Any ideas what the tutorial parser should be?

@neunenak
Copy link
Author

Any ideas what the tutorial parser should be?

Writing up how you went about writing the JSON parser would make for a reasonably simple tutorial example, I think.

In addition to that, I also think it would be good to have a very short, very simple parser - something that can be fully explained in a few paragraphs. This could be something as simple as parsing lists of integers separated by newlines out of a text file.

@fgdorais fgdorais added the documentation Improvements or additions to documentation label Dec 21, 2024
@fgdorais
Copy link
Owner

fgdorais commented Feb 6, 2025

Progress on this issue has been slow but it is happening. A very basic but nontrivial parser example was added to the README in #64. The JSON validator example was updated with considerable annotations in #65. This is not quite tutorial level yet but it's much better, I think. There is more to come...

@fgdorais fgdorais added the enhancement New feature or request label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants