Add inherited-members option to the gateway automodule configuration #354
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
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
|
@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 |
|
LGTM 👍 |
jburel
approved these changes
Nov 24, 2022
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.
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