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(metrics): Corrections to the docstrings code examples #314

Merged
merged 1 commit into from
Mar 7, 2021

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Mar 7, 2021

Description of changes:

Correct some of the code examples in the doc string

eg:

from aws_lambda_powertools.metrics import SingleMetric, MetricUnit

vs

from aws_lambda_powertools.metrics import single_metric, MetricUnit

Checklist

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

@codecov-io
Copy link

codecov-io commented Mar 7, 2021

Codecov Report

Merging #314 (6f887a7) into develop (b6e61e2) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #314      +/-   ##
===========================================
- Coverage    99.88%   99.88%   -0.01%     
===========================================
  Files           91       91              
  Lines         3340     3339       -1     
  Branches       162      162              
===========================================
- Hits          3336     3335       -1     
  Misses           2        2              
  Partials         2        2              
Impacted Files Coverage Δ
aws_lambda_powertools/metrics/metric.py 100.00% <ø> (ø)
aws_lambda_powertools/metrics/metrics.py 100.00% <ø> (ø)
aws_lambda_powertools/metrics/base.py 100.00% <100.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 b6e61e2...6f887a7. Read the comment docs.

@heitorlessa heitorlessa added area/utilities internal Maintenance changes labels Mar 7, 2021
@heitorlessa heitorlessa changed the title docs(metrics): Corrections to the code examples docs(metrics): Corrections to the docstrings code examples Mar 7, 2021
@heitorlessa heitorlessa added documentation Improvements or additions to documentation and removed internal Maintenance changes labels Mar 7, 2021
@heitorlessa
Copy link
Contributor

Thanks a lot Michael!!!

@heitorlessa heitorlessa merged commit bc17b5f into aws-powertools:develop Mar 7, 2021
@michaelbrewer michaelbrewer deleted the docstring-metrics branch March 7, 2021 07:33
heitorlessa added a commit that referenced this pull request Mar 9, 2021
…tools-python into develop

* 'develop' of https://github.com/awslabs/aws-lambda-powertools-python:
  feat(logging): Include exception_name (#320)
  chore: remove gatsby mention as migrated completed
  refactor(parameters): Consistently reference env (#319)
  docs(metrics): remove minimum dimensions
  docs: Correct code examples (#317)
  docs(metrics): Correct code examples in markdown (#316)
  fix(idempotency): TypeError when calling is_missing_idempotency_key with an int (#315)
  docs(metrics): Corrections to the code examples (#314)
  fix(idempotency): Correctly handle save_inprogress errors (#313)
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