Are API docs needed for this repo?
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず docs/sphinx-build.sh、.github/workflows/httomo_backends_docs.yml、docs/index.rst を読み、API 出力がどのように生成および公開されるかを追跡します。API ドキュメントをここに置くべきか判断する前に、httomo_backends/ 配下のスクリプトと参照されている httomo issue を確認します。リポジトリで API ドキュメントの範囲について合意され、その決定が build と index の設定に一貫して反映されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
There's API docs being generated in the sphinx-build.sh script: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/sphinx-build.sh#L27-L28
and similarly in the CI: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/.github/workflows/httomo_backends_docs.yml#L34-L35
but the output rst files from this aren't being included in index.rst (so the API docs aren't included in the final docs deployment).
So that's one reason why I'm questioning if API docs are needed for this repo, because they're being built but not being used in the final docs deployment.
Another reason is if this repo needs API docs. At the moment, there's a handful of scripts used for generating the YAML templates, and that's it. The httomo_backends/ dir isn't even a python package (there's no __init__.py file), so there's no python modules in this repo really, just some scripts for generating YAML templates.
One question is: do we need/want API docs for the handful of scripts currently here?
Another question: for stuff that gets moved to httomo-backends (such as memory estimators and padding calculators from httomo, see https://github.com/DiamondLightSource/httomo/issues/429), would we like API docs for those? At the moment in httomo, memory estimators are private functions where they reside, but I imagine that when they get moved into httomo-backends they'll be made public functions - which may make sense to have API docs as they're public, but may also not make sense to have API docs, because they all have the same interface (parameters), and their usage is made obvious by how they are used in httomo. In which case, perhaps API docs in httomo-backends isn't really needed, but rather, general documentation on how the memory estimator and padding calculator functions are used in httomo/how they hook into httomo.
- 主要言語
- 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
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 45/100
DiamondLightSource/httomo-backends の issue をすべて見る
似ている issue
-
md/asciidoc/csv: an explicit `encoding="utf-8"` keeps a leading BOM, the auto-detect path drops itオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
docling-project/docling#4846 ·
メンテナーはふだん 1 日以内に返信
-
area/sessions comp/dashboard comp/desktop comp/gateway comp/tui duplicate P2 sweeper:risk-session-state type/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
NousResearch/hermes-agent#138914 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bot-triaged module: activation checkpointing module: inductor oncall: pt2 triaged
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
[oblt-aw][autodoc] Update PR Actions Detective E2E prerequisites and fix dashboard-format table typoオープンdocumentation
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
elastic/oblt-aw#2382 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信