Fix nodoc to exclude test class from topic list
#457
Merged
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
It's been documented for a long time that you can set the class attribute `nodoc` to `True` for a test class, to exclude that class from appearing in the `topics.rst` file produced by `make_topics_doc`, which is publicly published as the definitive list of message topics. However, this has never actually worked properly, and test classes with `nodoc = True` *do* appear in the list. This fixes it, by checking the attribute correctly. Signed-off-by: Adam Williamson <awilliam@redhat.com>
|
Cool, thanks! |
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.
It's been documented for a long time that you can set the class
attribute
nodoctoTruefor a test class, to exclude thatclass from appearing in the
topics.rstfile produced bymake_topics_doc, which is publicly published as the definitivelist of message topics. However, this has never actually worked
properly, and test classes with
nodoc = Truedo appear inthe list. This fixes it, by checking the attribute correctly.
Signed-off-by: Adam Williamson awilliam@redhat.com