Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix `nodoc` to exclude test class from topic list #457

Merged
merged 1 commit into from Dec 14, 2017

Conversation

Projects
None yet
3 participants
@AdamWill
Copy link
Contributor

commented Dec 13, 2017

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

Fix `nodoc` to exclude test class from topic list
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>
@AdamWill

This comment has been minimized.

Copy link
Contributor Author

commented Dec 13, 2017

@ralphbean
Copy link
Contributor

left a comment

Yes!

@pypingou

This comment has been minimized.

Copy link
Member

commented Dec 14, 2017

Cool, thanks!

@pypingou pypingou merged commit ec4c457 into fedora-infra:develop Dec 14, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.