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): add testing your code section #1017

Merged
merged 2 commits into from
Feb 9, 2022

Conversation

to-mc
Copy link
Contributor

@to-mc to-mc commented Feb 9, 2022

Issue #, if available: #1009

Description of changes:

Add "Testing your code" section to the documentation for parameters utility.

Checklist

Breaking change checklist

RFC issue #:

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

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


View rendered docs/utilities/parameters.md

@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 9, 2022
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Feb 9, 2022
@codecov-commenter
Copy link

codecov-commenter commented Feb 9, 2022

Codecov Report

Merging #1017 (5e399b6) into develop (6869155) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1017   +/-   ##
========================================
  Coverage    99.96%   99.96%           
========================================
  Files          119      119           
  Lines         5347     5364   +17     
  Branches       610      612    +2     
========================================
+ Hits          5345     5362   +17     
  Partials         2        2           
Impacted Files Coverage Δ
aws_lambda_powertools/utilities/batch/sqs.py 100.00% <0.00%> (ø)

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 6869155...5e399b6. Read the comment docs.

Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

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

Looks great! One potential typo on mocking the incorrect namespace, and one question on whether a function factory would be more powerful as an example

docs/utilities/parameters.md Outdated Show resolved Hide resolved
docs/utilities/parameters.md Outdated Show resolved Hide resolved
@to-mc to-mc requested a review from heitorlessa February 9, 2022 14:53
@heitorlessa heitorlessa changed the title docs: Add testing section to docs for parameters utility docs(parameters): add testing your code section Feb 9, 2022
@to-mc to-mc merged commit 1f60f31 into develop Feb 9, 2022
@to-mc to-mc deleted the docs/testing_parameters branch February 9, 2022 15:43
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