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

Improve internal docs #28

Open
ltitanb opened this issue Jul 16, 2024 · 1 comment
Open

Improve internal docs #28

ltitanb opened this issue Jul 16, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@ltitanb
Copy link
Collaborator

ltitanb commented Jul 16, 2024

We need to have better internal docs:

  • functions, structs, and modules need to have rustdocs
  • the README needs to be tidied up and updated
@ltitanb ltitanb added the documentation Improvements or additions to documentation label Jul 16, 2024
@ltitanb
Copy link
Collaborator Author

ltitanb commented Aug 9, 2024

We should also document the generics, potentially having more descriptive naming, as discussed in #72

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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ltitanb