Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI make colourization optional for cmd --help #4284

Merged
merged 4 commits into from
Jul 4, 2021

Conversation

hjoliver
Copy link
Member

This is a small change with no associated Issue.

Some of our command help pages are quite long, so I sometimes like to grep in them, or open them in an editor cylc play --help | vim - in which case color control codes in the output are annoying. This hack makes --color=never work with --help.

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.py and conda-environment.yml. (No changes)
  • Does not need tests (why?).
  • Appropriate change log entry included.
  • No documentation update required.

@oliver-sanders
Copy link
Member

(recommend cylc help | less -r)

@oliver-sanders
Copy link
Member

Looks fine.

@hjoliver
Copy link
Member Author

hjoliver commented Jul 4, 2021

This is a trivial change that can't impact anything important, so I'll take @oliver-sanders' "Looks fine" as approval.

@hjoliver hjoliver merged commit 2489a5e into cylc:master Jul 4, 2021
@hjoliver hjoliver deleted the color-for-help branch July 4, 2021 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants