スタイルガイド

Pythonのドキュメントは，できるだけ Apple Publications Style Guide に従ってください．この特別なスタイルガイドは，手頃でオンラインで簡単に入手できることが主な理由です．

この文書では，Appleのスタイルガイドで扱われていないトピックについて説明します．

すべてのreSTファイルは，3つのスペースのインデントを使用します．通常のテキストの最大行長は80文字ですが，テーブル，深くインデントされたコードサンプル，および長いリンクは，それを超える場合があります．

必要に応じて空白行を多用します．グループ分けに役立ちます．

文の終了ピリオドの後には，1つまたは2つのスペースが続く場合があります．reSTは2番目のスペースを無視しますが，Emacsのauto-fillモードを補助するためなどに，一部のユーザがこれを入れるのが習慣です．

脚注は，特定の情報を提示する最良の方法である場合に使用されることがありますが，一般的には推奨されません．文末に脚注参照を追加する場合は，文末の句読点に続けます．reST markupは次のように表示されます．

This sentence has a footnote reference. [#]_ This is the next sentence.

脚注は，ファイルの最後，またはファイルが非常に長い場合はセクションの最後にまとめます．docutilsは脚注参照へのバックリンクを自動的に作成します．

脚注は，必要に応じて文の途中に表示することができます．

Pythonドキュメントでは，オペレーティングシステム，プログラミング言語，標準化団体などの名前を含め，多くの特殊な名前が使用されています．これらのエンティティーのほとんどには特別なマークアップは割り当てられていませんが，作成者がPythonドキュメンテーションでの表記の一貫性を維持するのに役立つように，ここでは好ましいスペルを示します．

その他の用語および用語についても，特に説明する必要があります．これらの表記規則を使用して，ドキュメント全体の一貫性を確保する必要があります．

CPU

"central processing unit." のために，多くのスタイルガイドは，これは最初の使用時に説明されるべきであると言います(どうしても使うなら，そうしなさい!)．Pythonのドキュメントでは，どのオカレンスが最初に表示されるかを予測する合理的な方法がないため，この省略形は使用しないでください．代わりに "processor" という言葉を使った方がいいです．

POSIX

特定の規格グループに割り当てられた名前．これは常に大文字です．

Python

お気に入りのプログラミング言語の名前は，常に大文字で入力します．

ユニコード

文字セットおよび対応するエンコーディングの名前．これは常に大文字で書かれます．

Unix

1970年代初期にAT&Tベル研究所で開発されたオペレーティングシステムの名称．