style.md

1> **Источник:** https://python-all.ru/3.0/documenting/style.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Руководство по стилю89Документация Python должна следовать [Apple Publications Style Guide](https://python-all.ru/3.0/documenting/style.html) везде, где это возможно. Это руководство по стилю было выбрано в основном потому, что оно кажется разумным и легко доступно онлайн.1011Темы, не освещённые в руководстве по стилю Apple, будут рассмотрены в этом документе.1213Все файлы reST используют отступ в 3 пробела. Максимальная длина строки – 80 символов для обычного текста, но таблицы, примеры кода с глубокими отступами и длинные ссылки могут выходить за этот предел.1415Активно используйте пустые строки, где это уместно; они помогают группировать связанные элементы.1617После точки в конце предложения может следовать один или два пробела; хотя reST игнорирует второй пробел, некоторые пользователи по традиции его ставят, например, для поддержки режима авто-заполнения Emacs.1819Сноски, как правило, не приветствуются, хотя они могут использоваться, когда являются лучшим способом представления конкретной информации. Когда ссылка на сноску добавляется в конце предложения, она должна следовать за знаком препинания, завершающим предложение. Разметка reST должна выглядеть примерно так:2021```rest22This sentence has a footnote reference. [#]_ This is the next sentence.23```2425Сноски должны быть собраны в конце файла, или, если файл очень длинный, в конце раздела. Docutils автоматически создаст обратные ссылки на ссылку на сноску.2627Сноски могут появляться в середине предложений, если это уместно.2829В документации Python используется множество специальных названий, включая названия операционных систем, языков программирования, организаций по стандартизации и тому подобное. Большинству этих сущностей не назначена специальная разметка, но здесь приведены предпочтительные написания, чтобы помочь авторам поддерживать единообразие оформления в документации Python.3031Другие термины и слова также заслуживают особого упоминания; эти соглашения следует использовать для обеспечения единообразия во всей документации:3233**CPU**3435Расшифровывается как «central processing unit». Многие руководства по стилю рекомендуют раскрывать аббревиатуру при первом использовании (и если вы всё же используете её, делайте это!). Для документации Python эту аббревиатуру следует избегать, так как нет разумного способа предсказать, какое вхождение читатель увидит первым. Лучше использовать слово «процессор».3637**POSIX**3839Название, присвоенное определённой группе стандартов. Всегда пишется заглавными буквами.4041**Python**4243Название нашего любимого языка программирования всегда пишется с заглавной буквы.4445**Unicode**4647Название набора символов и соответствующей кодировки. Всегда пишется с заглавной буквы.4849**Unix**5051Название операционной системы, разработанной в AT&T Bell Labs в начале 1970-х годов.52