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

Docs #2

Open
4 of 16 tasks
timsueberkrueb opened this issue Dec 7, 2018 · 0 comments
Open
4 of 16 tasks

Docs #2

timsueberkrueb opened this issue Dec 7, 2018 · 0 comments
Labels
enhancement New feature or request
Projects
v0.1.0

Comments

@timsueberkrueb
Copy link
Owner

timsueberkrueb commented Dec 7, 2018 •
edited
Loading

Create documentation with code examples. The code examples should get tested.

  • yalr
    • Document logos_support
  • yalr_cli
    • Document all public features
      • table (and options)
      • graph (and options)
  • yalr_codegen
    • Document the fact that this is not stable and not fit for public consumption, yet
  • yalr_core
    • Document all public types
      • TODO: add checklist
  • yalr_proc_macro
    • Document the syntax rules for rule
    • Document terminal_type
    • Document assoc
    • Document lalr
@timsueberkrueb timsueberkrueb added the enhancement New feature or request label Dec 7, 2018
@timsueberkrueb timsueberkrueb added this to To do in v0.1.0 via automation Dec 7, 2018
@timsueberkrueb timsueberkrueb moved this from To do to In progress in v0.1.0 Dec 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
v0.1.0
  
In progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@timsueberkrueb