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.

Sign up for GitHub

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

Jump to bottom

Post-fork documentation audit #100

Closed
2 tasks done
epage opened this issue Jan 30, 2023 · 2 comments · Fixed by #179
Closed
2 tasks done

Post-fork documentation audit #100

epage opened this issue Jan 30, 2023 · 2 comments · Fixed by #179
Labels
A-docs Area: Documentation C-enhancement Category: Raise on the bar on expectations
Milestone
0.3

Comments

@epage
Copy link
Collaborator

epage commented Jan 30, 2023

Please complete the following tasks

winnow version

0.2.0

Describe your use case

The documentation is still nom focused

Describe the solution you'd like

In forking from nom, we need to make sure the documentation

  1. doesn't refer to nom
  2. meets our needs / has a consistent style

Style

  • Nearly all of readme should be in doc comments
  • Mirror the style of clap (cookbook, tutorial, etc)
  • doc comments should have a single sentence introduction

Alternatives, if applicable

No response

Additional Context

No response
@epage epage added A-docs Area: Documentation C-enhancement Category: Raise on the bar on expectations labels Jan 30, 2023
@epage epage added this to the 0.3 milestone Jan 30, 2023
@epage
Copy link
Collaborator Author

epage commented Feb 1, 2023 •
edited

See also

@epage
Copy link
Collaborator Author

epage commented Feb 7, 2023

This should include doc alias to help people transitioning from other parser combiantors

This was referenced Feb 17, 2023
Merged
Merged
epage added a commit to epage/winnow that referenced this issue Feb 17, 2023
@epage
docs: Include aliases
db96f38 
Aliases were pulled from
- `nom`
- `chumsky`
- `combine`

This is a part of winnow-rs#100
This was referenced Feb 17, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation C-enhancement Category: Raise on the bar on expectations
Projects
None yet
Milestone
0.3
Development

Successfully merging a pull request may close this issue.

docs: Remove 'nom' from everything epage/winnow
1 participant
@epage