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

chore: cli help text: comma-separate alternative option forms #4911

Merged
merged 1 commit into from
Aug 4, 2024

Conversation

znssong
Copy link
Contributor

@znssong znssong commented Aug 4, 2024

The help message of Lean command line contains

--o=oname -o create olean file

This may lead to misunderstanding that the command needs both argument --o=oname and -o, i. e. lean --o=test.o -o test.lean. In the help message of GNU coreutils, such as ls, it is -a, --all ..., which might be better.
Some discussion is on Zulip thread https://leanprover.zulipchat.com/#narrow/stream/270676-lean4/topic/The.20help.20message.20of.20Lean.20command.20line.

@github-actions github-actions bot added the toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN label Aug 4, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Aug 4, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Aug 4, 2024
@nomeata nomeata changed the title chore: Changed the help message of command-line shell chore: cli help text: comma-separate alternative option forms Aug 4, 2024
@nomeata nomeata added this pull request to the merge queue Aug 4, 2024
Merged via the queue into leanprover:master with commit 2d09c96 Aug 4, 2024
14 checks passed
@leanprover-community-mathlib4-bot leanprover-community-mathlib4-bot added the builds-mathlib CI has verified that Mathlib builds against this PR label Aug 4, 2024
@leanprover-community-mathlib4-bot
Copy link
Collaborator

Mathlib CI status (docs):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builds-mathlib CI has verified that Mathlib builds against this PR toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants