hannibal-team team mailing list archive
-
hannibal-team team
-
Mailing list archive
-
Message #00001
PEP 8 и другие
Моё почтение, дамы и господа!
Исходя из рекомендаций PEP 8, предлагается придерживаться таких пунктов:
* комментарии и докстрины (__doc__, """It's a doc string""") только на англ;
* имена функций (методов) должны быть в стиле lower_case_with_underscores();
* имена классов должны быть в стиле MyPrecious();
* константы должны быть в стиле MAX_OVERFLOW;
* отступы длиной в 4 позиции с использованием пробелов;
* как с переменными? lowercase_style?
Относительно докстринов. Предлагаю сразу оформлять их как многострочные:
"""
This is a multi-line doc sctring
"""
Даже если можно уместить в одну линейку! Ибо потом содержимое может дополняться.
Как говорится, "на вырост".
Комментарии к ревизиям в системе контроля версий (bazzar) пишем на англ.
Все эти заморочки имеют под собой почву: Ганнибал живёт на лонче, где на нас смотрят
другие. Они же в любой момент могут к нам присоединиться.
На счёт локализации (gettext, *.po, etc). Сразу делаем, или потом?
С уважением,
Олег "Eleidan" Кулик