Possibly incorrect link to main page from "Templates generator"?
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
調査の方向性
docs/source/utilities/yaml_generator.rst から始めて :backends_content: 参照を確認し、その後 docs/source/index.rst での配置を docs/source/utilities/templates.rst と比較します。参照先がメインページではなく YAML テンプレートになっていることを確認します。完了の条件は、レンダリングされた Templates generator リンクから意図したテンプレートのドキュメントが開くことです。
索引モデルが issue の本文から書いたものです。
説明
The use of the reference :backends_content in this line: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/utilities/yaml_generator.rst?plain=1#L5
appears to be wanting to link to the YAML templates that have been generated.
However, while the text of the link is what is expected for a link to YAML templates:
it actually links to the main page, which doesn't seem like what would be intended?
The linking to the main page is likely due to the reference being put in index.rst: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/index.rst?plain=1#L3-L9
and should instead be moved to somewhere in the templates.rst file.
- 主要言語
- Python
- スター
- 0
- フォーク
- 1
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
DiamondLightSource/httomo-backends のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
documentation
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
documentation question
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
DiamondLightSource/httomo-backends#10 · コメント 2 件 ·
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 45/100
DiamondLightSource/httomo-backends の issue をすべて見る
似ている issue
-
python triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
microsoft/semantic-kernel#14615 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
shackett/shackett-utils#19 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
UKGovernmentBEIS/control-arena#917 ·
メンテナーはふだん 1 日以内に返信