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(typing): extract code examples #1127

Closed
wants to merge 16 commits into from

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Apr 13, 2022

Issue number:

Summary

Extract the code examples for the typing utility documentation

Changes

Please provide a summary of what's being changed

Changes:

  • Extract code example
  • Run isort and black
  • Update line highlight
  • Add make task for formatting and linting to prevent future errors

User experience

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

Examples has been extracted docs/examples/utilities/typing/ folder and are formatted (isort, black) and
compiled (py_compile) to ensure there are no longer any syntax errors or inconsistent formatting.

Hosted version is here: https://gyft.github.io/aws-lambda-powertools-python/latest/

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/typing.md

Changes:
- Extract code example
- Run isort and black
- Update line highlight
- Add make task for formatting and linting

Related to:
- aws-powertools#1064
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation internal Maintenance changes labels Apr 13, 2022
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 13, 2022
@michaelbrewer michaelbrewer changed the title fix(docs): Extract typing code examples fix(docs): Extract typing code examples Apr 13, 2022
@github-actions github-actions bot added the bug Something isn't working label Apr 13, 2022
@codecov-commenter
Copy link

codecov-commenter commented Apr 13, 2022

Codecov Report

Merging #1127 (9603b6f) into develop (9d8dd1b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1127   +/-   ##
========================================
  Coverage    99.88%   99.88%           
========================================
  Files          119      119           
  Lines         5423     5423           
  Branches       618      618           
========================================
  Hits          5417     5417           
  Misses           2        2           
  Partials         4        4           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9d8dd1b...9603b6f. Read the comment docs.

@heitorlessa heitorlessa changed the title fix(docs): Extract typing code examples docs(typing): extract code examples Apr 26, 2022
@heitorlessa heitorlessa removed the bug Something isn't working label Apr 26, 2022
@sthulb sthulb closed this Jun 14, 2022
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 internal Maintenance changes size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants