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

Improve docstrings for tari crypto #73

Closed
CjS77 opened this issue Jan 5, 2022 · 1 comment
Closed

Improve docstrings for tari crypto #73

CjS77 opened this issue Jan 5, 2022 · 1 comment

Comments

@CjS77
Copy link
Contributor

CjS77 commented Jan 5, 2022

There are many missing Docstrings on docs.rs for this crate.

Let's bring the state of this up to OSS standards:

  • Properly document all public API functions
  • Clearly outline the target audience and use cases for this crate, as well as the API design philosophy.
  • Clearly document the implicit contracts for contributors wanting to add additional implementations.
@CjS77
Copy link
Contributor Author

CjS77 commented Jul 4, 2022

Closed by #94

@CjS77 CjS77 closed this as completed Jul 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant