Skip to content

docs: fix misspelled parameters section in samconfig examples - #9459

Open
minilan677-netizen wants to merge 2 commits into
aws:developfrom
minilan677-netizen:docs/fix-samconfig-parameters-typo
Open

minilan677-netizen wants to merge 2 commits into
aws:developfrom
minilan677-netizen:docs/fix-samconfig-parameters-typo

Conversation

@minilan677-netizen

Copy link
Copy Markdown

Which issue(s) does this change fix?

None — small docs fix found while reading the samconfig docs.

Why is this change necessary?

docs/sam-config-docs.md uses [default.build.paramaters] and [default.local_start_api.paramaters] (misspelled) in its example samconfig.toml tables. SAM CLI reads command options from the parameters section, so anyone who copies these examples gets a config section that is silently ignored.

How does it address the issue?

Renames the three misspelled paramaters table headers to parameters. No other changes.

What side effects does this change have?

None — docs only.

Mandatory Checklist

PRs will only be reviewed after checklist is complete

  • Review the generative AI contribution guidelines
  • Add input/output type hints to new functions/methods — N/A (docs only)
  • Write design document if needed — N/A
  • Write/update unit tests — N/A (docs only)
  • Write/update integration tests — N/A
  • Write/update functional tests if needed — N/A
  • make pr passes — not run; docs-only change. Ran codespell on docs/*.md (clean after this change).
  • make update-reproducible-reqs if dependencies were changed — N/A
  • Write documentation

This PR was prepared with AI assistance and reviewed for correctness before submitting.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@minilan677-netizen
minilan677-netizen requested a review from a team as a code owner November 20, 2026 18:08
@github-actions github-actions Bot added pr/external stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at. labels Nov 20, 2026
bnusunny
bnusunny previously approved these changes Nov 20, 2026

@bnusunny bnusunny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This is correct. SAM CLI only reads [<env>.<command>.parameters], so anyone who copied these example tables got their settings silently ignored. On develop, git grep -i paramaters finds these 3 lines plus 2 more in designs/sam-config.md (lines 130 and 149). Fixing those as well is optional: the design doc is historical, but people do copy from it.

The reviewer noted two more misspelled `[*.build.paramaters]` section
headers in designs/sam-config.md. SAM CLI only reads
`[<env>.<command>.parameters]`, so copied examples would be silently
ignored. No other changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr/external stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants