Python and Django coding style (PEP)

Question

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?

Answer 1

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

Answer 2

There is no true code style rule. Every framework, library and software can redefine some style rule for its own project.

In my personal code I prefer to use the more general code style rule (in this case the official Python one) but you should specify this in your documentation.