Repository navigation
docs(parameters): correct the documented default of recursive per provider - #8610
SuellenQwQ wants to merge 1 commit into
Conversation
…vider docs/utilities/parameters.md documented `recursive` as defaulting to `True` for `get_multiple()`, but that only holds for the module-level `get_parameters()`; `SSMProvider.get_multiple()` defaults to `False`. Aligns the SSM options table with the code. No behaviour change - the provider default is intentionally left as-is to avoid a breaking change. Signed-off-by: SuellenQAQ <sulun6693485@163.com>
powertools-for-aws-oss-automation
Bot
added
the
size/XS
boring-cyborg
Bot
added
the
documentation
|
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
|
leandrodamascena
left a comment
leandrodamascena
left a comment
There was a problem hiding this comment.
Thanks @SuellenQwQ, this is right. The table sits in the SSMProvider section and the provider's get_multiple() defaults to False, only the module-level get_parameters() defaults to True, so the extra sentence is exactly what was missing. I also checked both defaults against a real Parameter Store path with nested parameters and the behavior matches what you documented.
I'm approving now. This goes out in 3.39.0, so it will sit here for a while before I merge it. No need to rebase or do anything else in the meantime, and you'll be credited in the release notes.
Issue number: closes #8598
Summary
Changes
docs/utilities/parameters.mddocumentsrecursiveas defaulting toTrueforget_multiple(), but that only holds for the module-levelget_parameters().SSMProvider.get_multiple()defaults toFalse(ssm.py:144), so the documented default is wrong for the provider entry point. This aligns the SSM options table with the code and adds a note about the module-level function default.User experience
No behaviour change: the provider default is intentionally left as-is to avoid a breaking change.
Checklist
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.