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

Documentation fixes #95

Open
tomato42 opened this issue Sep 5, 2018 · 1 comment
Open

Documentation fixes #95

tomato42 opened this issue Sep 5, 2018 · 1 comment
Labels
maintenance issues related to making the project usable or testable
Milestone

Comments

@tomato42
Copy link
Member

tomato42 commented Sep 5, 2018

A lot of documentation are comments, not documentation strings – they should be changed.

Most documentation strings don't actually document what the different arguments are and what the expected outputs are – using the sphinx format to document that would be nice.

Finally, many methods and functions are not documented at all, that should also be fixed.

@tomato42 tomato42 added the maintenance issues related to making the project usable or testable label Sep 5, 2018
@tomato42 tomato42 added this to the v0.15 milestone Sep 5, 2018
@tomato42 tomato42 modified the milestones: v0.15, v0.16 Nov 30, 2019
@tomato42 tomato42 modified the milestones: v0.16.0, v0.17.0 Jul 28, 2020
@tomato42
Copy link
Member Author

ecdsa module should also redirect people to keys, as that's where high-level API lives

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance issues related to making the project usable or testable
Projects
None yet
Development

No branches or pull requests

1 participant