Skip to content

docs(parameters): snippets split, improved, and lint #1564

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

Merged

Conversation

leandrodamascena
Copy link
Contributor

@leandrodamascena leandrodamascena commented Oct 2, 2022

Issue number: #1368

Summary

Changes

Changes snippet fictitious names to real code snippet filenames for easier discovery and collaboration to improve/correct document snippets.

Some examples have also been refactored so that the codes are complete and there are no lint/pre-commit hooks issues.

User experience

Before:
image

After:
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.


View rendered docs/utilities/parameters.md

@leandrodamascena leandrodamascena requested a review from a team as a code owner October 2, 2022 20:11
@leandrodamascena leandrodamascena requested review from mploski and removed request for a team October 2, 2022 20:11
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 2, 2022
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Oct 2, 2022
@codecov-commenter
Copy link

codecov-commenter commented Oct 2, 2022

Codecov Report

Base: 97.51% // Head: 97.51% // No change to project coverage 👍

Coverage data is based on head (b140445) compared to base (a556d28).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1564   +/-   ##
========================================
  Coverage    97.51%   97.51%           
========================================
  Files          143      143           
  Lines         6570     6570           
  Branches       466      466           
========================================
  Hits          6407     6407           
  Misses         128      128           
  Partials        35       35           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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

@heitorlessa heitorlessa self-assigned this Oct 3, 2022
@heitorlessa heitorlessa linked an issue Oct 3, 2022 that may be closed by this pull request
@leandrodamascena leandrodamascena requested review from heitorlessa and removed request for mploski October 18, 2022 14:13
@heitorlessa heitorlessa removed their request for review October 19, 2022 08:04
@heitorlessa heitorlessa requested review from heitorlessa and removed request for heitorlessa and rubenfonseca October 19, 2022 08:05
Copy link
Contributor

@rubenfonseca rubenfonseca left a comment

Choose a reason for hiding this comment

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

This is amazing work @leandrodamascena thank you! I left some small comments but I ask you the following two things:

  • can you please render the docs locally and manually check all the highlights to see if they make sense?
  • can you rebase the branch with develop?

We should be able to merge this very soon

@leandrodamascena
Copy link
Contributor Author

This is amazing work @leandrodamascena thank you! I left some small comments but I ask you the following two things:

  • can you please render the docs locally and manually check all the highlights to see if they make sense?
  • can you rebase the branch with develop?

We should be able to merge this very soon

Hei Ruben! Thanks a lot for the feedback. I addressed all issues you mentioned and I moved 2 code snippet from parameters.md file to example folder.

Copy link
Contributor

@rubenfonseca rubenfonseca left a comment

Choose a reason for hiding this comment

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

Great work!

@leandrodamascena leandrodamascena merged commit 3314893 into aws-powertools:develop Jan 31, 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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor Parameters docs code snippets
4 participants