Skip to content

docs(metrics): Correct code examples in markdown#316

Merged
heitorlessa merged 2 commits into
aws-powertools:developfrom
gyft:docs-metrics-md
Mar 7, 2021
Merged

docs(metrics): Correct code examples in markdown#316
heitorlessa merged 2 commits into
aws-powertools:developfrom
gyft:docs-metrics-md

Conversation

@michaelbrewer
Copy link
Copy Markdown
Contributor

@michaelbrewer michaelbrewer commented Mar 7, 2021

Description of changes:

Correct the metrics code examples to use MetricUnit.Count when it was imported otherwise
remove when not used in code sample

Checklist

@codecov-io
Copy link
Copy Markdown

codecov-io commented Mar 7, 2021

Codecov Report

Merging #316 (8cf29d9) into develop (bc17b5f) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #316   +/-   ##
========================================
  Coverage    99.88%   99.88%           
========================================
  Files           91       91           
  Lines         3339     3341    +2     
  Branches       162      163    +1     
========================================
+ Hits          3335     3337    +2     
  Misses           2        2           
  Partials         2        2           
Impacted Files Coverage Δ
...wertools/utilities/idempotency/persistence/base.py 99.35% <0.00%> (+<0.01%) ⬆️

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 bc17b5f...8cf29d9. Read the comment docs.

@michaelbrewer
Copy link
Copy Markdown
Contributor Author

Sorry one more @heitorlessa . I am picking them up as i try to copy and paste from the docs.

@heitorlessa heitorlessa added documentation Improvements or additions to documentation area/metrics labels Mar 7, 2021
Copy link
Copy Markdown
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.

Thanks ;) I had left no MetricUnit to make it easier for people coming from bare SDK or EMF library.

But makes sense to keep using our enum as that's a good feature

@heitorlessa heitorlessa merged commit 6c31cc6 into aws-powertools:develop Mar 7, 2021
@michaelbrewer
Copy link
Copy Markdown
Contributor Author

@heitorlessa cool, which ever code examples you would prefer people to copy from.

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