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

[Django + Python] Docstrings #132

Open
tuneerroy opened this issue Oct 12, 2022 · 0 comments
Open

[Django + Python] Docstrings #132

tuneerroy opened this issue Oct 12, 2022 · 0 comments

Comments

@tuneerroy
Copy link
Contributor

tuneerroy commented Oct 12, 2022

Some of the methods we write can become quite large or confusing. Help clear up the confusion by writing Python docstrings for individual methods.

The type of docstring we want is called reST (examples). While reST is recommended by PEP 287, there are many other ways to do docstrings in Python. At the end of the day, we want consistent formatting, but if you believe there's a strong case to be made for using a different style than reST, we're happy to hear it!

An example method that would be quite useful to have a docstring for can be found here.

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

No branches or pull requests

2 participants