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

Model lacks docstring #3

Open
jbrucker opened this issue Apr 30, 2024 · 0 comments
Open

Model lacks docstring #3

jbrucker opened this issue Apr 30, 2024 · 0 comments

Comments

@jbrucker
Copy link
Collaborator

Use docstrings to document your work while you are designing,
not at the end of the project.

Models are important. Both the class and all non-trivial methods should have descriptive docstrings. Not useless docstring like "this is the model class".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant