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

docs(parameters): improve readability on error handling get_parameter… #2833

Merged

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Jul 24, 2023

Issue number: #2749

Summary

Correct get_parameters API docstrings example, and improve explanation and readability in Fetching parameters section

Changes

Please provide a summary of what's being changed

User experience

Please share what the user experience looks like before and after this change

API docs

image

User-guide docs

image

Unrelated but obvious readability issue too now fixed

image

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

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.

@heitorlessa heitorlessa requested a review from a team as a code owner July 24, 2023 10:44
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jul 24, 2023
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 24, 2023
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
4.6% 4.6% Duplication

@codecov-commenter
Copy link

codecov-commenter commented Jul 24, 2023

Codecov Report

Patch coverage: 50.00% and no project coverage change.

Comparison is base (e6e2908) 97.54% compared to head (9d35345) 97.54%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2833   +/-   ##
========================================
  Coverage    97.54%   97.54%           
========================================
  Files          162      162           
  Lines         7469     7469           
  Branches       540      540           
========================================
  Hits          7286     7286           
  Misses         134      134           
  Partials        49       49           
Impacted Files Coverage Δ
aws_lambda_powertools/utilities/parameters/ssm.py 97.59% <ø> (ø)
aws_lambda_powertools/utilities/batch/base.py 94.21% <50.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@leandrodamascena leandrodamascena added this pull request to the merge queue Jul 24, 2023
Merged via the queue into aws-powertools:develop with commit ec62084 Jul 24, 2023
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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants