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: run and tryRun aren't parsers #89

Closed
mindplay-dk opened this issue Aug 13, 2023 · 1 comment · Fixed by #90
Closed

Docs: run and tryRun aren't parsers #89

mindplay-dk opened this issue Aug 13, 2023 · 1 comment · Fixed by #90
Labels
A-docs Area: Issues related to documentation A-structure Area: Issues related to repository/code structure

Comments

@mindplay-dk
Copy link
Contributor

I had trouble finding the run and tryRun functions, which are located in the "Parsers" section.

I would suggest adding a "Core" section at the top of the menu, and document the core functions of the library API there.

Probably moving the code itself into a "core" folder would make sense as well?

Let me know if you'd like a PR.

@norskeld
Copy link
Owner

norskeld commented Aug 13, 2023

You are right, this is confusing. I'm okay with moving run and tryRun into core folder and adding a section in the docs. I would move defer there as well. PR would be great, thanks!

P.S. I'll check other issues out and reply later, unfortunately day job and life stuff leave little to no time for pet projects at the moment.

@norskeld norskeld added A-docs Area: Issues related to documentation A-structure Area: Issues related to repository/code structure labels Aug 13, 2023
@norskeld norskeld linked a pull request Aug 13, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Issues related to documentation A-structure Area: Issues related to repository/code structure
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants