Fix format inconsistency in SAM CLI help text#8663
Conversation
|
Do you have an example of what some of the changed commands look like before and after? |
|
do you have a chance to remove the new tag from the main command help as well? |
|
I personally don't like all the extra space that some of the SAM CLI help outputs had, and now it looks like now we're unifying all the commands to have that extra space. (for example vs new Do you know why we have all the extra space? Is that a conscious decision? |
|
Now in the code I see that it's not just "a format thing", but we explicitly add new lines everywhere. Do we like that? |
Before the changes, some command had space between option description while some didn't. For consistency, either add space or remove all space. I chose to add because it provided clear separation especially for multiline description. Do you prefer no line like the before in here: #8663 (comment)? |
|
TODO: remove the new line between command option description. |






























Which issue(s) does this change fix?
Fix format inconsistency issue across SAM CLI help text.
Why is this change necessary?
SAM CLI commands had inconsistent help text formatting with different section structures, spacing, and organization. Some commands used custom formatters while others used the base CoreCommand pattern. This inconsistency made the CLI harder to read and maintain.
How does it address the issue?
CoreCommandpattern with consistent section structureindented_sectionformatting for example section with descriptive titlesRowDefinition(text="\n")for consistent spacing before command in example sectionsWhat side effects does this change have?
Mandatory Checklist
PRs will only be reviewed after checklist is complete
design-document))
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.