Sort interface names, to make documentation reproducible #1342
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.
can.VALID_INTERFACES
is a frozenset, and therefore an unordered collection.Therefore, the output of
python3 -m can.logger -h
(that is: the help for the--interface
flag) depends on the actual ordering of the elements, which is undefined.This means that the output (and in consequence the sphinx documentation) is not reproducible (as it might yield different results based on...whatever).
Since Reproducible Builds is a good thing™, this patch sorts the interfaces before displaying them.