Search code examples
pythoncoding-stylepep

Python and Django coding style (PEP)


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?


Solution

  • PEP 8 follows the first person singular. Django documentation standard follows the third person singular. The former one is standard.