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

Improving docs #268

Merged
merged 5 commits into from
Jul 24, 2018
Merged

Improving docs #268

merged 5 commits into from
Jul 24, 2018

Conversation

halfzebra
Copy link
Contributor

I've been constantly stumbling upon this when reading the docs. There are no links to mentioned parsers or combinators in the descriptions.

Please check out the result:

screen shot 2018-07-23 at 23 32 52

The links from the screenshot are pointing to the corresponding sections.

The rule for link replacement is:
If there's one parser or combinator in the code line, then it's replaced by the link.

Please let me know what do you think, I will continue on this if this is a good idea.

@coveralls
Copy link

coveralls commented Jul 23, 2018

Coverage Status

Coverage remained the same at 100.0% when pulling fb9c290 on halfzebra:improving-docs into 93b6c42 on jneen:master.

@wavebeem
Copy link
Collaborator

I like this a lot! thank you

@wavebeem wavebeem merged commit 3c4b8c9 into jneen:master Jul 24, 2018
@halfzebra halfzebra deleted the improving-docs branch July 24, 2018 11:39
@halfzebra
Copy link
Contributor Author

Thanks for a quick reply 👍

Happy you like it!

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

3 participants