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

Add explanation of operators in the example. #150

Closed
wants to merge 1 commit into from

Conversation

nmn
Copy link

@nmn nmn commented Sep 5, 2018

I found it super hard to read the example without knowing what the operators meant. So when I figured it out I add an explanation to the readme. This way, I also get to verify my understanding.

I found it super hard to read the example without knowing what the operators meant. So when I figured it out I add an explanation to the readme. This way, I also get to verify my understanding.
@seliopou
Copy link
Member

Hey thanks for this pull request. I think the motivation behind it is good, but it also kindof duplicates some of the documentation that's already in the .mli. Just having a reference to the mli for folks that need further explanation may be less duplicative and ensure that documentation remains consistent. Just something like "For an explanation of the operators involved in the implementation of this parser, see the (documentation in the ml)".

If you're interested in making that change, I'll certainly merge it. Otherwise, let me know and I'll go ahead and make the change.

@seliopou
Copy link
Member

Closing in favor of #158. Thanks for pointing this out!

@seliopou seliopou closed this Nov 10, 2018
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.

None yet

2 participants