In the institution block we talk about the `lifetime`, which applies to the facilities. Do we want to move this somewhere else? Add it to the second scenario as a more advanced concept.
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
調査の方向性
source/user/tutorial/add_reg_inst.rst から始め、特に Concept: Institutions セクションと、そこにある name、lifetime、config、initialfacilitylist の説明を確認してください。facility prototypes の定義と regions に関する関連資料を確認し、そのうえで、一般的な入力ファイル構造または lifetime に関する説明をどこに置くべきかを決めてください。これらの概念を重複させたり先送りしたりせず、明確で合意された説明がドキュメントに記載されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Sub-issue of #427 that I felt needed more discussion.
in source/user/tutorial/add_reg_inst.rst we talk about the lifetime input with the institutions (see the Concept: Institutions section). We talk about the name, lifetime, config, and initialfacilitylist section. The last one is unique to institutions, but the others apply to the facility prototype definition sections (which are discussed before institutions) and regions. Therefore, it feels weird to me for us to wait so long to explicitly call out those tags.
Should we add a page just talking about the general format/structure of an input file? Any other ideas on how to reconcile this disconnect?
- 主要言語
- Python
- スター
- 8
- フォーク
- 33
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
cyclus/cyclus.github.com のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
cyclus/cyclus.github.com#454 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
cyclus/cyclus.github.com#453 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
cyclus/cyclus.github.com#448 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
cyclus/cyclus.github.com#445 ·
-
[Task] Update tutorial files in Zenodo Object再び着手できるかも @connor-welch が 265 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン0 - Backlog
cyclus/cyclus.github.com#441 · コメント 3 件 · 担当者 1 名 ·
cyclus/cyclus.github.com の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
[BUG] Multi-day events show "Ended" while still in progress対応中かも @tarunagnihotri534 が今日担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
data-umbrella/du-event-board#231 · コメント 2 件 ·
-
avl_automation: the generated control surface block isn't valid XML (typo in avl_out_parse.py)対応中かも @brksol が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
PX4/PX4-gazebo-models#164 ·