Docs: Check sorting in reference metrics listing #3378
+162
−8
Conversation
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
badboy
force-pushed
the
push-muxyskmkptwv
branch
from
832817f to
906a996
Compare
badboy
force-pushed
the
push-muxyskmkptwv
branch
from
906a996 to
aa79305
Compare
chutten
approved these changes
Jan 16, 2026
Contributor
chutten
left a comment
chutten
left a comment
There was a problem hiding this comment.
Let's see if I have this sorted:
- Add in test-only deps for reading markdown (commonmark dialect) and calling out to shell.
- New test that
- parses the metrics index's markdown until it finds the first list
- removes the list
- reprints the list after sorting it in a custom way (case-insensitive, putting labeled below unlabeled, dual-labeled below labeled, string_list below string)
- dumps the rest of the doc as written
- test success if no change happened, test fail if there was a diff
Seems good to me. Now do the TOC : D
| // We need to handle a few special cases: | ||
| // | ||
| // * Dual-labeled and labeled metrics should be sorted right after their top-level metric type | ||
| // * Normalizing plurals to be sorted correctly after the singular (quantity -> quantitys) |
Contributor
There was a problem hiding this comment.
Suggested change
| // * Normalizing plurals to be sorted correctly after the singular (quantity -> quantitys) | |
| // * Normalizing plurals to be sorted correctly after the singular (quantity -> quantities) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Just to know how hard it would be I implemented the lint that checks our metrics reference stays sorted.
Implemented as a test and calling git for the diff.
That automatically gives us the correct ordering by just running the test too.
wdyt, @chutten ?