Potentially confusing print by YAML checker when checking a loader is first in the pipeline
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
Research direction
Start in httomo/yaml_checker.py around lines 102-122, where the checker verifies that the first pipeline method is a loader and prints its success message. Make the message describe only that first-method check, then verify that it remains clear when another loader validation, such as duplicate-parameter detection, fails.
Written by the indexing model from the issue text.
Description
There's a check that is making sure that the first method in the pipeline YAML file is a loader:https://github.com/DiamondLightSource/httomo/blob/2e15a80e8e96753bc8a0d13285209cdbd9a56434/httomo/yaml_checker.py#L102-L122
If the check passes, the message printed is: https://github.com/DiamondLightSource/httomo/blob/2e15a80e8e96753bc8a0d13285209cdbd9a56434/httomo/yaml_checker.py#L120
However, in the event that:
- this check passes
- but other checks fail in the loader (such as a duplicate parameter)
this message being printed is confusing, because "loader check successful" implies that the loader config is error-free, but in reality this is not the case.
I think the message should be updated to be more specific in stating that the check for the first method being a loader was successful, to avoid such confusion in cases where the check passes but other checks that involve the loader fail. Maybe something like:
Loader first in pipeline check successful
- 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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DiamondLightSource/httomo
-
ci
Difficulty 1/5 Under an hour Newbie friendliness 88/100
DiamondLightSource/httomo#714 ·
-
framework minor
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
DiamondLightSource/httomo#699 ·
-
documentation question
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/httomo#697 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
DiamondLightSource/httomo#609 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
DiamondLightSource/httomo#607 ·
All issues in DiamondLightSource/httomo
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100