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

Add docstrings #7

Open
Jerenaux opened this issue Jan 8, 2020 · 0 comments
Open

Add docstrings #7

Jerenaux opened this issue Jan 8, 2020 · 0 comments
Labels
📄 documentation Improvements or additions to documentation 🌱 good to get started Good for newcomers to the project

Comments

@Jerenaux
Copy link
Owner

Jerenaux commented Jan 8, 2020

Most methods in the codebase lack proper docstrings explaining

  • What the method does
  • When/by what is it usually called
  • What are arguments
  • What is the returned value

Eventually, all methods should be documented that way! If you want to contribute but are not sure about some methods, feel free to ask on one of the community channels.
@Jerenaux Jerenaux added 📄 documentation Improvements or additions to documentation 🌱 good to get started Good for newcomers to the project labels Jan 8, 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 🌱 good to get started Good for newcomers to the project
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Jerenaux