Repository navigation
docs: fix misspelled parameters section in samconfig examples - #9459
Open
minilan677-netizen wants to merge 2 commits into
Open
minilan677-netizen wants to merge 2 commits into
minilan677-netizen wants to merge 2 commits into
Conversation
bnusunny
previously approved these changes
Nov 20, 2026
bnusunny
left a comment
Contributor
There was a problem hiding this comment.
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.
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
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.
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.mduses[default.build.paramaters]and[default.local_start_api.paramaters](misspelled) in its examplesamconfig.tomltables. SAM CLI reads command options from theparameterssection, so anyone who copies these examples gets a config section that is silently ignored.How does it address the issue?
Renames the three misspelled
paramaterstable headers toparameters. No other changes.What side effects does this change have?
None — docs only.
Mandatory Checklist
PRs will only be reviewed after checklist is complete
make prpasses — not run; docs-only change. Rancodespellondocs/*.md(clean after this change).make update-reproducible-reqsif dependencies were changed — N/AThis 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.