Skip to content

Conversation

dcabib
Copy link
Contributor

@dcabib dcabib commented Sep 4, 2025

Summary

This PR fixes incorrect syntax highlighting in the Parameters utility documentation for SSM Provider recursive parameters, addressing issue #7281.

Changes Made

• Fixed highlighting to focus on Powertools-specific code instead of boto3 setup
• Changed hl_lines="6 19-25" to hl_lines="6 26 32" in SSM recursive parameter example

Before

# Highlighted boto3 session setup (lines 19-25) - not relevant for learning Powertools

After

# Highlights actual Powertools usage:
# Line 6: Powertools import
# Line 26: SSMProvider creation  
# Line 32: get_multiple() method call

Why This Matters

The current highlighting teaches users about AWS SDK setup, but developers come to learn about Powertools. The fix focuses attention on the actual Powertools-specific code that matters for learning the utility.

Issue number: closes #7281


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

- Change hl_lines from '6 19-25' to '6 26 32'
- Focus highlighting on Powertools-specific code instead of boto3 setup
- Improves developer learning experience for Parameters utility

Closes aws-powertools#7281
@dcabib dcabib requested a review from a team as a code owner September 4, 2025 13:54
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Sep 4, 2025
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 4, 2025
Copy link

sonarqubecloud bot commented Sep 4, 2025

@leandrodamascena leandrodamascena merged commit f29a8cb into aws-powertools:develop Sep 4, 2025
15 checks passed
@dcabib dcabib deleted the docs/fix-ssm-recursive-parameter-highlighting branch September 4, 2025 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Parameters / SSM Provider / recursive parameters snippet has incorrect highlighting
2 participants