Astropyナラティブ·スタイルガイド：投稿者用の執筆資源¶
本スタイルガイドの目的は、Astropyドキュメントを作成する際に参考にすることができるAstropyコミュニティにスタイルおよびフォーマットガイドのセットを提供することです。このスタイルガイドで提供されているガイドラインに従って、Astropyの文書により大きな一貫性と明瞭性をもたらし、Python天文学汎用コアソフトウェアパッケージの開発の使命をサポートし、相互操作可能な天文パッケージ生態系を育成します。
本スタイルガイドはアルファベット順にテーマを作成し，各部分に用法例があり，末尾にイントネーションとフォーマットガイドがある.
略語.¶
縮約(例えば、和)を丸括弧に入れて、後にコンマをつけます。あるいは、“That is”と“例えば”を用いて、前に破折番号や分番号をつけ、後にコンマをつけたり、破折番号に含めたりすることが考えられます。
実例.¶
フレーム内のデータを修正する唯一の方法は
dataフレームワーク上のコンポーネントのエイリアスではなく属性(すなわち，以下の操作は機能しない).これが超えているので、より複雑な進化(例えば、非慣性系またはより複雑な進化)を支持する計画はありません。
astropyコアです。座標オブジェクトを持つと、完全な座標の文字列表現形式を得るために、座標のコンポーネント(例えば、RAまたはDEC)にアクセスすることができる。
一般的および科学的用語の場合、略語用語は、天文学コミュニティにおいて広く知られ、広く使用されている場合にのみ使用される。あまり一般的でない科学用語、または特定の分野に固有の用語については、用語または解釈リソースへのリンクが書かれてください。何かを省略すべきかどうかを決めるとき、良い経験則は、疑問があるときは、それを書くことです。
実例.¶
1次元，2次元などは1次元，2次元などに優先される.
SIやCGSのような単位は省略できるが，これは科学界ではより一般的である。
白矮病はWDと略称するのではなく、完全に書かなければならない。
略語を使用する組織または他の固有名詞の名前は、その既知の縮約語として書かれるべきであるが、参照のために、ウェブサイトまたはリソースへのハイパーリンクを有する。 CODATA それがそうです。
大文字である.¶
プレーンテキストでは，すべての固有名詞(名前)は大文字であるが，パッケージ/コード名と言及した場合は除外し，この場合は小文字と二重引用符を用いる.Astropy CapitalizedとはAstropy Projectのことです astropy 小文字と逆引用符とはコアバッグのことです。
実例.¶
Astropyのガイドラインに従ってコードに貢献する。
付属パッケージは天文学関連のパッケージで、属していません
astropyコアパック。コード例とオペレーティングシステムおよびPythonの詳細を提供します
numpyそして、astropyあなたが使用しているバージョンです。
文書材料では，見出しは大文字を優先し，大文字の1番目，最後の1つと見出し中のすべての主要単語を意味するが，小文字冠詞(the，a，an)，前置詞(at，to，up，down，with，inなど)とよく見られる並列接続詞(and，out，for，or)を意味する.文サイズは，長い例の見出しに対して受け入れられる.
実例.¶
建設と設置
データのないフレーム
貢献コードチェック表
Astropyガイド
輸入
astropy和子パッケージ例：速度を用いて異なる暦の空位置を計算する.
チュートリアルや他の学習材料では，構造化紹介/テンプレート部分のタイトルはタイトル大文字が選択されているが，チュートリアルでは，異なる学習/コード部分を指定する長いタイトルに対しては，文サイズ(すなわち，1番目の単語と固有名詞のみを大文字にする)が受け入れられる.
宮縮.¶
正式な文書材料に略語を使わないでください。
実例.¶
ご変更があれば影響を与えます
astropy性能を向上させるためには、性能基準の追加を考慮してください。ChangeLogエントリを含める必要はありません。
他のすべての材料では，時制が混同される可能性がある場合にのみ略語の使用を避け，たとえば“She‘re go”や“She Have Gone”などの場合には略語を用いる.
連字.¶
句形容詞/複合修飾語は名詞の前にハイフンで結ばれ，混同を避けるべきである
実例.¶
天文学関連のパッケージ。
Astropyは天文学コミュニティに持続可能で高いレベルの教育を提供する。
ハイフン付き複合語は平文にハイフンを含むべきであるが，コードにハイフンを含むべきではない.
例を引く¶
あなたの書式をよくチェックするのを忘れないでください。
数字¶
数字のかかと単位や名前の一部として、数字を使ってください。
実例.¶
1角分
32度
GAIA Data Release 2ディレクトリ
1次元，2次元などは1次元，2次元などに優先される.
他のすべての整数については、AP(AP)のスタイルに従ってください：数字1~9をつづり、10以上の数字を使用し、数-単語の組み合わせを使用して数百万、数十億、および数兆を表す。
実例.¶
Astropy文書を構築できる2つの方法がある.
以下の11ステップに従う.
約20億個の恒星を天体測定した。
勝手な表現には、数字をつづってください。
例を引く¶
1枚の写真は千言万語に勝る。
句読点.¶
Astropy材料を一致させるために、米国句読点の先頭オプションを反映するために、非米国句読点を編集する。
丸括弧記号. ：挿入性材料に属する句読点は右括弧内に置かれるが，コンマを除いて，挿入性材料の後に小さなポーズがあることと，別の文に挿入性材料を含む句点を表す.
実例.¶
(完全な投稿者ガイドについては、私たちの文書を参照してください。)
引取要求を開いたら(それに対しては)
master分岐機構)は，以下の内容が含まれていることを確認してください.場合によっては、必要な機能の多くは、単一のクラス(またはいくつかのクラス)に含まれる。
引用符. ：句読点と読点は右引用符に入れ、二重引用符でも単引用符でも。
実例.¶
これらの用語の中で，最も主なのは“座標系”の概念である.
“座標系”という意味の間には混同がある可能性があるため
coordinatesこの用語の使用を可能な限り避ける。
ハイフンvs.en破折番号vs.em破折番号
ハイフン(−)はフレーズ形容詞や複合語に適用される(参照 Hyphenation (前文参照)。
短い下線(-long)は数字の範囲(日付，時間，ページ)や置換単語“to”や“through”に適用され，下線の周囲にスペースがあるべきではない.
実例.¶
第14章-18章を参照。
私たちは新しいバージョンを開発するために2019年3月から2019年5月まで封鎖しました。
破折番号(-long)は、拡大要素または解釈要素を分離するために、コンマ、丸括弧、またはコロンの代わりに使用されてもよい。Astropy素材では、emごとに折り目の両側にスペースを残すAP(AP)のスタイルに従っている。
実例.¶
いくつかのタイプの入力角度(配列、スカラ、タプル、文字列)を使用して、角度オブジェクトを作成することができる。
角度オブジェクトの作成は、複数の入力角度タイプ−配列、スカラ、タプル、文字列などをサポートします。
つづり字.¶
Astropy材料を一致させるために、米国ではないスペルを編集してアメリカのスペルトップオプションを反映させます。
例を引く¶
交差マッチングリスト座標(リストと比較)
時間と日付¶
適切な時間を表現する際には数字を用いる.24時間制で正確な時間を表示します。Astropyマテリアルを一致させるために、24時間制システムの先頭オプションを反映するために、正確な時間のすべての事例を編集する。
例を引く¶
講演は15：00に始まります。
特定の日付は、ISO 8601フォーマットの数字、年−月−日として表される。
例を引く¶
ガイアタスクのデータは2018年4月25日に発表された。
アクセントに関する一注記¶
すべてのAstropy材料の記述部分では、以下の音声とイントネーションガイドに従ってください。
現在形で書く。
例を引く¶
次の部分で、私たちはストーリーを作るつもりだ…
あなたのバージョンがあるかどうかをテストします
astropy正常に作動している...
一人称を含む複数を用いる
例を引く¶
私たちは遠くまで歩いたが、次は近道をしてみることができる…
“一”ではなく、汎用代名詞“あなた”を使います。
例を引く¶
以下のようにフレーム上の任意の属性にアクセスすることができます。
“明らか”“簡単”“簡単”“公正”や“単刀直入”など、どうでもいい言葉や軽視しないようにしましょう。“私たちはもう一つのことをしなければならない”というようなどうでもいい言葉を避ける。
読者の心の中で懸念を引き起こす言葉やフレーズを避ける。代わりに、積極的な言語を使って学んだスキルに対する自信を築く。
実例.¶
ベスト実践として..
おすすめの一つの方法は…
覚えなければならない重要な点は…
これらの考え方によれば，“警告”コマンドを用いることは，読者のスキルや知識における暗黙的な制約ではなく，コード中の制約しか説明できない.
ドキュメント、チュートリアル、ガイド¶
書類¶
口調：学術的で、やや正式である。
節タイトルには見出し小文字を用いる.
略語は使わないでください。
教程¶
口調：学術的だが、そんなに正式ではなく、もっと友好的だ。
ハローワーク/テンプレートタイトルにはタイトル大文字を用い，学習/例部分タイトルでは文サイズに切り替える.
チャプタタイトルは、コマンドムードを使用してコマンドまたは要求(例えば、“データのダウンロード”)を形成すべきである。
時制がはっきりしていれば、略語を使うことができます。
ガイドレール.¶
口調：学術的だが、そんなに正式ではなく、もっと友好的だ。
ハローワーク/テンプレートタイトルにはタイトル大文字を用い，学習/例部分タイトルでは文サイズに切り替える.
時制がはっきりしていれば、略語を使うことができます。
フォーマットガイド.¶
Astropy文書はSphinx文書生成器を用いてreStruredTextで書かれている.文書ファイルの異なる部分をフォーマットする際には、Astropy RSTファイル中の各部分タイトル階層構造の一貫性を維持するために、以下のガイドラインに従ってください。
テキストと同じ長さの句読点を用いて節タイトルに下線を引く(またはオプションに下線を付ける)ことで，reStrutiredTextファイル中の節タイトルを作成することができる.
実例.¶
*************************
This is a Chapter Heading
*************************
This is a Section Heading
=========================
正式に指定された文字はタイトルレベル階層構造を作成するためにはないが、階層構造の提示は連続するタイトルによって決定されるため、以下はAstropy文書ファイルフォーマットを設定する際に従うべき提案約束である。
#に下線を付け，部分*に下線を加え，節=，節-に対して小節^，小節に対して“，段落に対して
これらのガイドはSphinxに従っています Sections 中のreStructiredText PrimerとPythonの約束の章 7.3.6. Sections そのスタイルガイドの一部です。
その他の執筆資源¶
Astropy文書を作成する際に有用である可能性のある他のいくつかのリソースは、：