_PipelineSelection: implement __repr__ for docs reproducibility#2139
Open
tti0 wants to merge 1 commit into
Open
_PipelineSelection: implement __repr__ for docs reproducibility#2139tti0 wants to merge 1 commit into
tti0 wants to merge 1 commit into
Conversation
tti0
requested review from
BenjaminSchubert,
abderrahim,
cs-shadow,
gtristan and
juergbi
as code owners
sphinx-click uses __repr__ when rendering the default option of a click.choice in the documentation. Implementing this on _PipelineSelection gives more helpful (and reproducible) documentation than the default representation, `<buildstream.types._PipelineSelection object at 0x7f775b6b4ec0>`.
tti0
force-pushed
the
tti0/repr-impl-docs
branch
from
b8bf0ee to
00544d3
Compare
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
1 participant
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.
I have been looking to package BuildStream's documentation alongside the application and library in Debian. Debian policy now requires that binary packages, including documentation, are reproducible, so this MR is motivated by fixing the (only) reproducibility failure Debian CI discovered in BuildStream's documentation, in the
Using / Commandspage.This is my first upstream patch to BuildStream, so I am of course happy to adjust as needed. Thank you for your consideration!
sphinx-click uses
__repr__when rendering thedefaultoption of aclick.choicein the HTML documentation [ref].Implementing
__repr__on_PipelineSelectiongives more helpful (and reproducible) documentation than the default representation,<buildstream.types._PipelineSelection object at 0x7f775b6b4ec0>. As an example in the documentation ofbst show:Mainline:
This branch: