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

Help users become contributors by documenting the internal design of the library #253

Closed
anko opened this issue Jun 6, 2018 · 3 comments

Comments

@anko
Copy link
Contributor

anko commented Jun 6, 2018

Writing this comment explaining ._ reminded me that it took me a little while to understand Parsimmon's internal design from reading its source.

I think a prose introduction to the internals would help people get started as contributors. Perhaps a src/readme.md?

@anko anko changed the title Document the internal conventions like ._ and its return values, and mergeReplies Help users become contributors by documenting the internal design of the library Jun 6, 2018
@wavebeem
Copy link
Collaborator

wavebeem commented Jun 6, 2018

src/README.md or a comment block inside parsimmon.js… I could go either way on that. Probably a src/README.md though?

I definitely think this is a good idea.

@wavebeem
Copy link
Collaborator

wavebeem commented Jun 6, 2018

I definitely agree it took me some time to get the hang of the internals as well, so I can see this being helpful for sure :)

wavebeem pushed a commit that referenced this issue Jun 15, 2018
@wavebeem
Copy link
Collaborator

I think this will be fixed via Parsimmon v2, whenever I get around to that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants