Sort CSV list of known entities to prevent needless doc updates #911
Conversation
This file contains 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
We return a comma-separated list of known entities which is used to generate the known entities in error messages and help output, but it turns out that the order is not stable because we read the known entities from iterating over a map. Let's sort the keys before returning them to prevent getting documentation update PRs that just switch the order.
JAORMX
approved these changes
Sep 8, 2023
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.
We return a comma-separated list of known entities which is used to
generate the known entities in error messages and help output, but it
turns out that the order is not stable because we read the known
entities from iterating over a map. Let's sort the keys before returning
them to prevent getting documentation update PRs that just switch the
order.