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

Documentation #1

Open
4 of 10 tasks
devmessias opened this issue May 14, 2022 · 0 comments
Open
4 of 10 tasks

Documentation #1

devmessias opened this issue May 14, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@devmessias
Copy link
Collaborator

devmessias commented May 14, 2022 •
edited

  • Docstrings (create and fix all)
  • make target to create the documentation
  • automatic update the documentation after a release
  • create examples
  • cache system
  • how to use mypy
  • how to use pyre
  • examples using type inference with rules and regex
  • wikipedia and contributing.md
  • put the architecture and state machine diagrams
@devmessias devmessias added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jun 1, 2022
@devmessias devmessias pinned this issue Jun 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@devmessias