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

Refine the documentation #14

Open
GuillaumeFavelier opened this issue May 28, 2020 · 0 comments
Open

Refine the documentation #14

GuillaumeFavelier opened this issue May 28, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation
Projects
Global Roadmap

Comments

@GuillaumeFavelier
Copy link
Owner

The docstrings are too short. They should include at least:

  • Parameters
  • Returns
@GuillaumeFavelier GuillaumeFavelier created this issue from a note in Global Roadmap (To Do) May 28, 2020
@GuillaumeFavelier GuillaumeFavelier added the documentation Improvements or additions to documentation label May 28, 2020
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
Global Roadmap
  
To Do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GuillaumeFavelier