search

ome / omero-py

Python project containing Ice remoting code for OMERO
https://www.openmicroscopy.org/omero
GNU General Public License v2.0
20 stars 31 forks source link

Add inherited-members option to the gateway automodule configuration #354

Closed sbesson closed 1 year ago

sbesson commented 1 year ago

As most of these classes are effectively aliases/inherited, the current generated API documentation is pretty bare for the omero.gateway package as most methods are inherited from private base classes. This commit investigates using the inherited-members option to expose the docstrings

sbesson commented 1 year ago

@will-moore @jburel see https://omero-py--354.org.readthedocs.build/en/354/omero.gateway.html#gateway._BlitzGateway as a starting point of feedback and discussion (for reference, https://omero-py.readthedocs.io/en/v5.13.0/omero.gateway.html#gateway.BlitzGateway is the current version of this page)

The options add a fair amount of verbosity but something of that nature is necessary in order to expose the docstrings for pieces of functionality as central e.g. the BlitzGateway constructor. I believe this is primarily a consequence of the current design of the gateway where for instance the public BlitzGateway class inherits from a private _BlitzGateway class where all the public API methods are defined

will-moore commented 1 year ago

LGTM 👍

jburel commented 1 year ago

https://omero-py.readthedocs.io/en/stable/omero.gateway.html