juaml/junifer
Watch
3
0
Fork
You've already forked junifer
 0
Code Issues 14 Pull requests 2 Packages Activity Actions

[BUG]: CLI help has the wrong format #130

Merged
synchon merged 2 commits from fix/help-text-in-term into main 2022-11-15 09:43:18 +00:00
Conversation 3 Commits 2 Files changed 2 +6 -5
synchon commented 2022-11-15 09:27:35 +00:00 (Migrated from github.com)
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

(junifer)juseless ➜  junifer git:(feat/import) junifer run --help
Usage: junifer run [OPTIONS] FILEPATH

  Run command for CLI.

  Parameters ---------- filepath : click.Path     The filepath to the
  configuration file. element : str     The element to operate using. verbose
  : click.Choice     The verbosity level: warning, info or debug (default
  "info").

Options:
  --element TEXT
  -v, --verbose [warning|info|debug]
  --help                          Show this message and exit.

### Expected Behavior

(junifer)juseless ➜ junifer git:(feat/import) junifer run --help
Usage: junifer run [OPTIONS] FILEPATH

Run junifer using the configuration from FILEPATH

Options:
--element TEXT
-v, --verbose [warning|info|debug]
--help Show this message and exit.

Steps To Reproduce

junifer run --help

Environment

junifer:
  version: 0.0.1.dev927
python:
  version: 3.9.12
  implementation: CPython
dependencies:
  click: 8.1.3
  numpy: 1.21.2
  datalad: 0.15.5
  pandas: 1.4.1
  nibabel: 3.2.2
  nilearn: 0.9.0
  sqlalchemy: 1.4.32
  yaml: '6.0'
system:
  platform: Linux-4.19.0-21-amd64-x86_64-with-glibc2.28
environment:
  LC_CTYPE: en_US.UTF-8
  PATH: /usr/lib/fsl/5.0:/home/fraimondo/anaconda3/envs/junifer/bin:/home/fraimondo/anaconda3/condabin:/home/fraimondo/.dotfiles/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/X11R6/bin:/usr/local/games:/usr/games

Relevant log output

No response

Anything else?

No response

### Is there an existing issue for this? - [X] I have searched the existing issues ### Current Behavior ``` (junifer)juseless ➜ junifer git:(feat/import) junifer run --help Usage: junifer run [OPTIONS] FILEPATH Run command for CLI. Parameters ---------- filepath : click.Path The filepath to the configuration file. element : str The element to operate using. verbose : click.Choice The verbosity level: warning, info or debug (default "info"). Options: --element TEXT -v, --verbose [warning|info|debug] --help Show this message and exit. ### Expected Behavior ``` (junifer)juseless ➜ junifer git:(feat/import) junifer run --help Usage: junifer run [OPTIONS] FILEPATH Run junifer using the configuration from FILEPATH Options: --element TEXT -v, --verbose [warning|info|debug] --help Show this message and exit. ### Steps To Reproduce `junifer run --help` ### Environment ```markdown junifer: version: 0.0.1.dev927 python: version: 3.9.12 implementation: CPython dependencies: click: 8.1.3 numpy: 1.21.2 datalad: 0.15.5 pandas: 1.4.1 nibabel: 3.2.2 nilearn: 0.9.0 sqlalchemy: 1.4.32 yaml: '6.0' system: platform: Linux-4.19.0-21-amd64-x86_64-with-glibc2.28 environment: LC_CTYPE: en_US.UTF-8 PATH: /usr/lib/fsl/5.0:/home/fraimondo/anaconda3/envs/junifer/bin:/home/fraimondo/anaconda3/condabin:/home/fraimondo/.dotfiles/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/X11R6/bin:/usr/local/games:/usr/games ``` ### Relevant log output _No response_ ### Anything else? _No response_
codecov[bot] commented 2022-11-15 09:28:24 +00:00 (Migrated from github.com)
Copy link

Codecov Report

Merging #130 (920b3df) into main (19ecaa2) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #130   +/-   ##
=======================================
  Coverage   92.18%   92.18%           
=======================================
  Files          57       57           
  Lines        2226     2226           
  Branches      414      414           
=======================================
  Hits         2052     2052           
  Misses        136      136           
  Partials       38       38
Flag Coverage Δ
docs 100.00% <ø> (ø)
junifer 92.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
junifer/api/cli.py 78.94% <ø> (ø)
# [Codecov](https://codecov.io/gh/juaml/junifer/pull/130?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report > Merging [#130](https://codecov.io/gh/juaml/junifer/pull/130?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (920b3df) into [main](https://codecov.io/gh/juaml/junifer/commit/19ecaa29dc4bc1ec2751a74ab4b4df1ab02e290c?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (19ecaa2) will **not change** coverage. > The diff coverage is `n/a`. [![Impacted file tree graph](https://codecov.io/gh/juaml/junifer/pull/130/graphs/tree.svg?width=650&height=150&src=pr&token=5H21JuZXMw&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)](https://codecov.io/gh/juaml/junifer/pull/130?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #130 +/- ## ======================================= Coverage 92.18% 92.18% ======================================= Files 57 57 Lines 2226 2226 Branches 414 414 ======================================= Hits 2052 2052 Misses 136 136 Partials 38 38 ``` | Flag | Coverage Δ | | |---|---|---| | docs | `100.00% <ø> (ø)` | | | junifer | `92.16% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/juaml/junifer/pull/130?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [junifer/api/cli.py](https://codecov.io/gh/juaml/junifer/pull/130/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9hcGkvY2xpLnB5) | `78.94% <ø> (ø)` | |
fraimondo (Migrated from github.com) approved these changes 2022-11-15 09:31:51 +00:00
github-actions[bot] commented 2022-11-15 09:32:12 +00:00 (Migrated from github.com)
Copy link
PR Preview Action v1.2.0
Preview removed because the pull request was closed.
2022-11-15 09:47 UTC
[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v1.2.0 :---: Preview removed because the pull request was closed. 2022-11-15 09:47 UTC <!-- Sticky Pull Request Commentpr-preview -->
Sign in to join this conversation.
Reviewers
No reviewers
fraimondo
Labels
Clear labels   
CRITICAL
High Priority Issue

  
Stale

   
WIP
Work in progress

  
bug
Something isn't working

  
concept
Design/Implementation concepts

  
coordinate
Issues or pull requests related to coordinates (ROIs)

  
dataset
Issues or pull requests related to datagrabbers or datasets

  
dependencies
Pull requests that update a dependency file

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
github_actions
Pull requests that update GitHub Actions code

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
maintenance
Issues or pull requests related to maintenance

  
maps
Issues or pull requests related to maps (probabilistic atlases)

  
marker
Issues or pull requests related to markers

  
mask
Issues or pull requests related to masks

  
on hold
Issue waiting on other issue(s)

  
parcellation
Issues or pull requests related to parcellations (deterministic atlases)

  
preprocess
Issues or pull requests related to preprocessors

  
question
Further information is requested

  
ready
Pull request is ready for review and merge

  
storage
Issues or pull requests related to marker storage or retrieval

  
template-space
Issues or pull requests related to template spaces

  
triage
New issues waiting to be reviewed

  
wontfix
This will not be worked on

No labels
CRITICAL
Stale
WIP
bug
concept
coordinate
dataset
dependencies
documentation
duplicate
enhancement
github_actions
good first issue
help wanted
invalid
maintenance
maps
marker
mask
on hold
parcellation
preprocess
question
ready
storage
template-space
triage
wontfix
Milestone
Clear milestone
No items
No milestone
0.0.1 (alpha 0)
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
juaml/junifer!130
No description provided.