astronomy-commons / hipscat-import

HiPSCat import - generate HiPSCat-partitioned catalogs
https://hipscat-import.readthedocs.io
BSD 3-Clause "New" or "Revised" License
5 stars 2 forks source link

Inherit docstrings from super-classes #306

Closed delucchi-cmu closed 2 months ago

delucchi-cmu commented 2 months ago

Feature request

For example, the ImportArguments [1] class has lots of fields/methods that it inherits from the superclass [2], but users would have to navigate to the superclass to find them. All properties and methods should be displayed on classes.

This may be supported with autodoc show_inheritance.

[1] https://hipscat-import.readthedocs.io/en/stable/autoapi/hipscat_import/catalog/arguments/index.html [2] https://hipscat-import.readthedocs.io/en/stable/autoapi/hipscat_import/runtime_arguments/index.html

Before submitting Please check the following:

delucchi-cmu commented 2 months ago

Addressed in https://github.com/astronomy-commons/hipscat-import/pull/310