Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Document pipeline transformations applied by `UiLayer`

オープン 初心者向け
  • 何か問題がありますか？
#585 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
68/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

httomo/ui_layer.py のリンクされた UiLayer の public method signature から始め、続いて周辺の実装とクラス docstring を読みます。外部形式の変換以外のパイプライン変換、特に side output references が関連する method-wrapper parameter dictionaries 内でどのように OutputRef オブジェクトになるかを文書化します。UiLayer のドキュメントがこの動作を正確に説明していれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

From the signature of its single public method: https://github.com/DiamondLightSource/httomo/blob/c7e399d09f56a238e4c731c5f66857047f7f4752/httomo/ui_layer.py#L50

it's clear enough that UiLayer is used to produce a Pipeline.

However, transforming pipeline data from some external format (eg, YAML) into a Pipeline is not all that it does, it makes some additional changes. These additional changes should be documented somewhere (possibly in the class docstring).

The only transformation it applies I think is taking side output references and inserting appropriate OutputRef objects into the parameter dicts of the relevant method wrappers.

主要言語
Python
スター
10
フォーク
5
平均マージ
6分
マージ済み PR（30日）
1

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

DiamondLightSource/httomo のほかの issue

DiamondLightSource/httomo の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。