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(validation): extract and fix code examples #1128

Closed
wants to merge 17 commits into from

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Apr 13, 2022

Issue number:

Summary

Extract code examples for validation documentation

Changes

Please provide a summary of what's being changed

Changes:

  • Extract code examples
  • Run isort and black
  • Fix python syntax errors
  • Update line highlights
  • Add make task to lint and format examples to prevent future errors

Bug Fixes included in this PR:

User experience

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

Fixes some of the python code examples, and added linting and syntax checks to prevent regressions.

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

Changes:
- Extract code examples
- Run isort and black
- Fix python syntax errors
- Update line highlights
- Add make task

Related to:
- aws-powertools#1064
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 13, 2022
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation internal Maintenance changes labels Apr 13, 2022
@michaelbrewer michaelbrewer changed the title fix(docs): Extract validation code examples fix(docs): Extract validation 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 #1128 (89cb216) into develop (9d8dd1b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1128   +/-   ##
========================================
  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...89cb216. Read the comment docs.

@michaelbrewer michaelbrewer changed the title fix(docs): Extract validation code examples fix(docs): Extract and fix validation code examples Apr 20, 2022
@heitorlessa heitorlessa changed the title fix(docs): Extract and fix validation code examples docs(validation): extract and fix 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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants