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

docs(examples): generic parse combinator in arithmetic #583

Conversation

guissalustiano
Copy link

Hi, thanks for the work here!

I'm just learning about the library having used nom before, and one thing I had trouble with was learning how to create simple generic combinators, I think an example of that is in order.

The drawback I can see would be to make this example more complex.

Thanks!

@guissalustiano guissalustiano force-pushed the generic_combinator_example branch from 748a826 to ac15d7c Compare August 5, 2024 02:59
@epage
Copy link
Collaborator

epage commented Aug 15, 2024

We try to keep the API in such a condition that all of it can serve as examples. However, that might not always be obvious and some of those examples still might be slightly more general than the user needs.

However, I don't think this is the most discoverable place as we are putting it in one example among a bunch and the likelihood of the user finding it is low. Finding an appropriate place within the tutorial would likely be the best approach. The question is where. If you want to move forward with that path, I'd recommend we talk further on an Issue about your fundamental concern with the documentation (helping users know how to create combinators)

@guissalustiano
Copy link
Author

closed for #588

@guissalustiano guissalustiano deleted the generic_combinator_example branch August 24, 2024 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants