chore: order alphabetical error codes and constants in reference#569
Merged
Conversation
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
zimeg
added
the
semver:patch
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #569 +/- ##
==========================================
- Coverage 71.66% 71.65% -0.01%
==========================================
Files 226 226
Lines 19148 19154 +6
==========================================
+ Hits 13722 13725 +3
- Misses 4217 4218 +1
- Partials 1209 1211 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
zimeg
commented
Jun 2, 2026
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
zimeg
changed the title
The ErrorCodeMap is a Go map, so iteration order was random — the generated errors.md output was non-deterministic. Sort entries by their Code field before rendering the template. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
zimeg
changed the title
WilliamBergamin
approved these changes
Jun 3, 2026
Comment on lines
+121
to
+128
| errors := make([]slackerror.Error, 0, len(slackerror.ErrorCodeMap)) | ||
| for _, e := range slackerror.ErrorCodeMap { | ||
| errors = append(errors, e) | ||
| } | ||
| slices.SortFunc(errors, func(a, b slackerror.Error) int { | ||
| return strings.Compare(a.Code, b.Code) | ||
| }) | ||
| err = tmpl.Execute(file, errors) |
Contributor
There was a problem hiding this comment.
If the errors are already sorted do we need this? Or are go Maps unordered?
Member
Author
There was a problem hiding this comment.
@WilliamBergamin I understand maps don't have a specified order so want to build confidence in these outputs 📠 But I do realize this doesn't change our actual pages...
💡 thought: Will sit on this a bit before merging because it's additional code to maintain-
Member
Author
|
@WilliamBergamin I slept on this a bit and will go ahead with merging now to make it more explicit what we expect in outputs! Thank you for reviewing 🎁 ✨ |
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.
Changelog
N/A — no change to behavior but docs of #553 might keep new order 👁️🗨️ 📚
Summary
This pull request sorts the
internal/slackerror/errors.gofile alphabetically and ensuresdocgenproduces deterministic output.ErrXxxidentifier nameErrorCodeMapentries sorted by map keydocgennow explicitly sorts errors before rendering the templatePreview
Testing
diffof this PR has matching additions 🔬Notes
The Go spec states (ref):
Without explicit sorting,
docgenoutput depends on undefined map iteration order, which can vary across Go versions and builds.Requirements