search

reanahub / reana-client

REANA command-line client
http://reana-client.readthedocs.io/
MIT License
10 stars 44 forks source link

docs(cli): fix `open` command documentation typo (#716) #716

Closed clelange closed 2 months ago

clelange commented 2 months ago

Fix typo that I spotted during the demo this morning.

clelange commented 2 months ago

Does this need an issue for commitlint to be happy?

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 58.62%. Comparing base (3465eb0) to head (9a4dfc2).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/reanahub/reana-client/pull/716/graphs/tree.svg?width=650&height=150&src=pr&token=b85cSEiOhs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=reanahub)](https://app.codecov.io/gh/reanahub/reana-client/pull/716?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=reanahub) ```diff @@ Coverage Diff @@ ## master #716 +/- ## ======================================= Coverage 58.62% 58.62% ======================================= Files 24 24 Lines 2393 2393 ======================================= Hits 1403 1403 Misses 990 990 ``` | [Files](https://app.codecov.io/gh/reanahub/reana-client/pull/716?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=reanahub) | Coverage Δ | | |---|---|---| | [reana\_client/cli/workflow.py](https://app.codecov.io/gh/reanahub/reana-client/pull/716?src=pr&el=tree&filepath=reana_client%2Fcli%2Fworkflow.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=reanahub#diff-cmVhbmFfY2xpZW50L2NsaS93b3JrZmxvdy5weQ==) | `63.73% <ø> (ø)` | |
tiborsimko commented 2 months ago

Does this need an issue for commitlint to be happy?

We are attaching the PR number at the end, basically simulating GitHub's squash-merge behaviour. This is so that the PR would be linked in the Release-Please-compiled changelog items. Please see some details on the commit message here: https://github.com/reanahub/reana/wiki/Tips-for-Git#commit-message-style

No worries though, we can do these little cosmetic things while merging. E.g. in this case, I would suggest the commit log message:

docs(cli): fix `open` command documentation typo (#716)

(Note also the usage of docs instead of fix type, since this is a documentation-only change.)

I'll amend your PR in the above sense and merge.