Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I write code with Python using Django framework.
Now I have read about all these coding style advices, but encountered a vague thing.
In djangoproject section here https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#python-style it says that function comments should say like:
Does that, returns that.
However, here http://www.python.org/dev/peps/pep-0257/#one-line-docstrings it says that it should say like:
Do that, return that.
So, which option is true?
PEP 8 follows the first person singular. Django documentation standard follows the third person singular. The former one is standard.