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

fill in empty doc strings #10

Open
gage-russell opened this issue Sep 13, 2022 · 0 comments
Open

fill in empty doc strings #10

gage-russell opened this issue Sep 13, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@gage-russell
Copy link
Owner

gage-russell commented Sep 13, 2022

Fill in doc-strings containing TODO and nothing else.

preferred style:

     """
     Descirption ....

     Parameters
     ----------
     arg1 : type hinting; default
         description
     index : type hinting; default
         description

     Returns
     -------
     name : type hinting; description
     """
@gage-russell gage-russell changed the title Documentation (please) fill in empty doc strings Sep 14, 2022
@gage-russell gage-russell added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant