astronomy-commons/hats-import

Inherit docstrings from super-classes

Closed this issue · 1 comments

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:

  • I have described the purpose of the suggested change, specifying what I need the enhancement to accomplish, i.e. what problem it solves.
  • I have included any relevant links, screenshots, environment information, and data relevant to implementing the requested feature, as well as pseudocode for how I want to access the new functionality.
  • If I have ideas for how the new feature could be implemented, I have provided explanations and/or pseudocode and/or task lists for the steps.

Addressed in #310