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

Add Missing Docstrings #44

Open
MaggieFero opened this issue Mar 3, 2024 · 0 comments
Open

Add Missing Docstrings #44

MaggieFero opened this issue Mar 3, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@MaggieFero
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
The codebase currently has five instances of the linter exemption "# pylint: disable=missing-function-docstring", most of which are in tests and one of which is currently annoying me as I try to debug the thing that does not have the docstring.

Describe the solution you'd like
I should go through and write the docstrings once we have this repo back into a stable state.

Describe alternatives you've considered
We shouldn't be considering alternatives to writing the docstrings imo, we should just do it.

Additional context
Docstrings are currently missing in three tests as well as erase_deleted_user_data.py, but we should just search for the linter exception once we're ready to work on this in case it's changed.

@MaggieFero MaggieFero added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Mar 3, 2024
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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant