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: add testing tips, increase content width, and improve log sampling wording #174

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Sep 22, 2020

Issue #, if available: #161

Description of changes:

  • Add Pytest fixture for Metrics for those testing specific behaviour
  • Improve Log Sampling wording
  • Add Pytest fixture for unit test code using Logger inject decorator
  • Increase content width to 87vw to ease reading more complex content like guides/tutorials (to come)

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.

@heitorlessa heitorlessa added the documentation Improvements or additions to documentation label Sep 22, 2020
@codecov-commenter
Copy link

codecov-commenter commented Sep 22, 2020

Codecov Report

Merging #174 into develop will increase coverage by 0.09%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           develop      #174      +/-   ##
============================================
+ Coverage    99.90%   100.00%   +0.09%     
============================================
  Files           52        52              
  Lines         2151      2154       +3     
  Branches        96        97       +1     
============================================
+ Hits          2149      2154       +5     
+ Misses           1         0       -1     
+ Partials         1         0       -1     
Impacted Files Coverage Δ
aws_lambda_powertools/tracing/tracer.py 100.00% <0.00%> (ø)
aws_lambda_powertools/utilities/batch/sqs.py 100.00% <0.00%> (ø)
...ambda_powertools/utilities/validation/validator.py 100.00% <0.00%> (+9.52%) ⬆️

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 b654ca6...fd19e73. Read the comment docs.

@heitorlessa heitorlessa requested a review from to-mc September 22, 2020 13:51
Copy link
Contributor

@to-mc to-mc left a comment

Choose a reason for hiding this comment

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

Just 1 suggested change, otherwise LGTM!

docs/content/core/logger.mdx Outdated Show resolved Hide resolved
Co-authored-by: Tom McCarthy <[email protected]>
@heitorlessa heitorlessa merged commit 7311c5d into aws-powertools:develop Sep 22, 2020
@heitorlessa heitorlessa deleted the improv/docs-logger-metrics-testing branch September 22, 2020 15:32
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants