mason: annotate CLI help examples and fix their alignment - #519
Merged
elainewang-db merged 1 commit intoSep 3, 2026
Merged
Conversation
qinxinw-db
approved these changes
Sep 3, 2026
Each example now carries a short comment explaining what it does, so first-time users can scan `--help` without running commands. Commands stay flush-left in a clean column; a group renders its comments inline when every command is short enough (aligned across the group), and stacks them on the line above otherwise — uniformly per group so the layout never mixes inline and stacked. Addresses the "poor command readability" bug-bash feedback (inconsistent indent, no explanation of what examples do). Co-authored-by: Isaac <no-reply@databricks.com>
elainemwang
force-pushed
the
fix-help-examples-readability
branch
from
September 3, 2026 20:55
e3a9842 to
bc0b801
Compare
elainewang-db
enabled auto-merge (squash)
September 3, 2026 20:59
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Each example now carries a short comment explaining what it does, so first-time users can scan
--helpwithout running commands. Commands stay flush-left in a clean column; a group renders its comments inline when every command is short enough (aligned across the group), and stacks them on the line above otherwise — uniformly per group so the layout never mixes inline and stacked.Addresses the "poor command readability" bug-bash feedback (inconsistent indent, no explanation of what examples do).