Improve discoverability of what are dimension tuples#224
Merged
kukushechkin merged 3 commits intoMay 7, 2026
Merged
Conversation
heckj
requested changes
May 7, 2026
heckj
left a comment
heckj
left a comment
Contributor
There was a problem hiding this comment.
Generally looks great, a few minor tweaks while we're here
Co-authored-by: Joseph Heck <j_heck@apple.com>
heckj
approved these changes
May 7, 2026
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.
Add explanation to
dimensionsarguments of which tuple value is what.Motivation:
We have
([String, String])all over theswift-metrics, but never explain which tuple value is what (even if it looks obvious). We cannot change this to a type alias without breaking the API (even if atypealiasis source-compatible with the type it represents), as suggested in #43. But we can at least explain which tuple value is what.Modifications:
dimensionsargument comments now have(name, value)in the description.Result:
Dimensions tuple structure is discoverable without digging through the examples.