tti0 opened a new pull request, #2139: URL: https://github.com/apache/buildstream/pull/2139
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 / Commands` page. 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 the `default` option of a `click.choice` in the HTML documentation [[ref](https://github.com/click-contrib/sphinx-click/blob/e8eb75e292ff6df69230420d992a34e68a7385d0/sphinx_click/ext.py#L124)]. Implementing `__repr__` on `_PipelineSelection` gives more helpful (and reproducible) documentation than the default representation, `<buildstream.types._PipelineSelection object at 0x7f775b6b4ec0>`. As an example in the documentation of `bst show`: _Mainline:_ <img height="150" alt="image" src="https://github.com/user-attachments/assets/fcdd3496-a3c6-47e9-a332-7af885bcdd31"; /> _This branch:_ <img height="150" alt="image" src="https://github.com/user-attachments/assets/e18442cc-6bad-4588-b1e7-c77052dca922"; /> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
