[Doc] Not all relevant methods shown by autoclass

Bug #1745650 reported by Jeremy Freudberg
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Python client library for Sahara
Fix Released
Undecided
Unassigned

Bug Description

Supporting APIv2 in saharaclient meant that there is now some fancier inheritance going on, so Sphinx :members: now misses a bunch of user-facing methods.

:inherited-members: could do the trick, but it might end up showing too much stuff. so probably we have to use the :members method1, method2: type of syntax to say exactly what we want.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-saharaclient (master)

Reviewed: https://review.openstack.org/538317
Committed: https://git.openstack.org/cgit/openstack/python-saharaclient/commit/?id=ee5f17307a1d7949ce2408f22c3678966d3272c1
Submitter: Zuul
Branch: master

commit ee5f17307a1d7949ce2408f22c3678966d3272c1
Author: Jeremy Freudberg <email address hidden>
Date: Fri Jan 26 18:02:47 2018 +0000

    Auto-document members properly

    Supporting APIv2 in saharaclient meant that there is now some fancier
    inheritance going on, so Sphinx :members: now misses a bunch of
    user-facing methods. Now, start using :inherited-members: to get what
    we want.

    Additionally, put the v2 docs under the main reference section instead
    of in their own section.

    Change-Id: I56067fe54332497f8d0962986383b74a27d84a76
    Closes-Bug: #1745650

Changed in python-saharaclient:
status: New → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-saharaclient 1.5.0

This issue was fixed in the openstack/python-saharaclient 1.5.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.