Out of date mention of python pipelines in `UiLayer` docstring

Open Beginner friendly
#582 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Open httomo/ui_layer.py and inspect the UiLayer docstring around lines 28-32. Update the documentation so it no longer mentions Python pipeline files, reflecting the removal described in pull request 527. Done when the docstring accurately describes the remaining supported inputs without that outdated reference.

Written by the indexing model from the issue text.

Description

documentation

Python pipelines support was removed in https://github.com/DiamondLightSource/httomo/pull/527, but the docstring of UiLayer still mentions that feature: https://github.com/DiamondLightSource/httomo/blob/4e4b9d9bdf6e69d97aff840554ec9630b048e2c4/httomo/ui_layer.py#L28-L32

The docstring should be updated accordingly to not mention python pipeline files.

Dominant language
Python
Stars
10
Forks
5
Avg merge
5d 17h
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DiamondLightSource/httomo

All issues in DiamondLightSource/httomo

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.