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

Bug: Inconsistent examples of using the shell commands #7780

Open
miketheman opened this issue Dec 8, 2024 · 2 comments
Open

Bug: Inconsistent examples of using the shell commands #7780

miketheman opened this issue Dec 8, 2024 · 2 comments
Labels
stage/needs-feedback Needs feedback from the community (are you also interested in/experiencing this?) stage/pm-review Waiting for review by our Product Manager, please don't work on this yet type/bug

Comments

@miketheman
Copy link

Description:

When running any --help command, the examples should reflect what a user would actually copy/paste, and there are some that do not display a space between the $ representing a shell prompt and the actual command.

Basically, any time there's a command, either remove the preceding $ or add a space.

Steps to reproduce:

sam --help

or

sam sync --help

(This is not a comprehensive audit of all command examples)

Observed result:

...shellsession
Examples:

    Get Started:        $sam init
...
  By default, `$sam sync` runs a full AWS Cloudformation stack update.
...

Examples:

    $sam sync --watch --stack-name {stack}

    $sam sync --code --watch --stack-name {stack}

    $sam sync --code --stack-name {stack} --resource-id {ChildStack}/{ResourceId}
...



### Expected result:
<!-- Describe what you expected. -->

```shellsession
Examples:

    Get Started:        $ sam init
Examples:

    $ sam sync --watch --stack-name {stack}

    $ sam sync --code --watch --stack-name {stack}

    $ sam sync --code --stack-name {stack} --resource-id {ChildStack}/{ResourceId}

Additional environment details (Ex: Windows, Mac, Amazon Linux etc)

{
  "version": "1.131.0",
  "system": {
    "python": "3.13.0",
    "os": "macOS-15.1.1-x86_64-i386-64bit-Mach-O"
  },
  "additional_dependencies": {
    "docker_engine": "Not available",
    "aws_cdk": "Not available",
    "terraform": "1.5.7"
  },
  "available_beta_feature_env_vars": [
    "SAM_CLI_BETA_FEATURES",
    "SAM_CLI_BETA_BUILD_PERFORMANCE",
    "SAM_CLI_BETA_TERRAFORM_SUPPORT",
    "SAM_CLI_BETA_RUST_CARGO_LAMBDA"
  ]
}```
@miketheman miketheman added the stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at. label Dec 8, 2024
@vicheey vicheey added type/feature Feature request stage/needs-feedback Needs feedback from the community (are you also interested in/experiencing this?) stage/pm-review Waiting for review by our Product Manager, please don't work on this yet and removed stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at. labels Dec 12, 2024
@vicheey
Copy link

vicheey commented Dec 12, 2024

@miketheman , Thank you for your feedback. We'll look into this.

@vicheey vicheey added type/bug and removed type/feature Feature request labels Dec 12, 2024
@vicheey
Copy link

vicheey commented Dec 17, 2024

We will track the improvement internally to improve our help section for sam cli.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stage/needs-feedback Needs feedback from the community (are you also interested in/experiencing this?) stage/pm-review Waiting for review by our Product Manager, please don't work on this yet type/bug
Projects
None yet
Development

No branches or pull requests

2 participants