Стиль кодирования Python и Django (PEP)

Question

Я пишу код на Python, используя фреймворк Django.Теперь я прочитал обо всех этих советах по стилю кодирования, но столкнулся с неясной вещью.

В разделе djangoproject здесь https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#python-style сказано, что комментарии к функциям должны иметь вид:

Делает это, возвращает это.

Тем не менее, здесь http://www.python.org/dev/peps/pep-0257/#one-line-docstrings говорит, что должно сказать, как:

Сделайте это, верните это.

Итак, какой вариант является верным?

Answer 1

PEP 8 следует от первого лица единственного числа.Стандарт документации Django следует за третьим лицом единственного числа.Первый стандарт.

Answer 2

Нет true правила стиля кода.Каждый фреймворк, библиотека и программное обеспечение могут переопределить какое-то правило стиля для своего собственного проекта.

В моем личном коде я предпочитаю использовать более общее правило стиля кода (в данном случае официальное правило Python), но вы должны указать этов вашей документации.