docs(metrics): add documentation for AddDimensions method#1237
Merged
hjgraca merged 1 commit intoJul 15, 2026
Merged
Conversation
powertools-for-aws-oss-automation
Bot
added
the
size/L
|
boring-cyborg
Bot
added
documentation
|
Tick the box to add this pull request to the merge queue (same as
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1237 +/- ##
========================================
Coverage 79.46% 79.46%
========================================
Files 302 302
Lines 12662 12662
Branches 1507 1507
========================================
Hits 10062 10062
Misses 2142 2142
Partials 458 458 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fixes #1236
Summary
Issue number: #1236
Changes
Adds documentation for the
AddDimensionsmethod to the metrics utility docs, alongside the existingAddDimensionsection. Includes a code snippet, EMF output example, and an info box clarifying that both methods produce the same single dimension set. Also adds a unit test validating the merged behavior and fixes indentation in the existing EMF example.User experience
Before: Only
AddDimension(singular) was documented. Users discoveringAddDimensionson the interface had no guidance on usage or behavior.After: Both methods are documented with examples showing they produce identical EMF output - a single merged dimension set.
Checklist
Please leave checklist items unchecked if they do not apply to your change.
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.