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 docstrings & type signatures #109

Closed
nbraud opened this issue Jan 18, 2019 · 1 comment
Closed

Improve docstrings & type signatures #109

nbraud opened this issue Jan 18, 2019 · 1 comment

Comments

@nbraud
Copy link
Collaborator

nbraud commented Jan 18, 2019

From #106 :

That's indeed not very nice. OTOH, help() is currently useless on Vector2 because:

  • Type constructs like VectorLike are expanded into an illegible mess.
  • Description & documentation are in the README rather than in docstrings.

I think it would be worth fixing, but it's way out of scope for this PR.
@nbraud
Copy link
Collaborator Author

nbraud commented Jan 18, 2019

Suggestion:

  • improve type signatures;
  • move documentation from README to docstrings;
  • generate a documentation page from the docstrings (in CI), link to it from README.

Does that seem sensible?

@nbraud nbraud mentioned this issue Jan 19, 2019
Closed
3 tasks
@nbraud nbraud mentioned this issue Mar 24, 2019
Merged
bors bot added a commit that referenced this issue Mar 26, 2019
@bors @AstraLuma @nbraud
Merge #130
b1c6247 
130: Add Sphincs-based documentation r=pathunstrom a=nbraud

Closes #109 

Co-authored-by: Jamie Bliss <jamie@ivyleav.es>
Co-authored-by: Nicolas Braud-Santoni <nicolas@braud-santoni.eu>
@bors bors bot closed this as completed in #130 Mar 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nbraud