Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inherit docstrings from super-classes #306

Closed
3 tasks done
delucchi-cmu opened this issue May 13, 2024 · 1 comment
Closed
3 tasks done

Inherit docstrings from super-classes #306

delucchi-cmu opened this issue May 13, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@delucchi-cmu
Copy link
Contributor

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.
@delucchi-cmu delucchi-cmu added the enhancement New feature or request label May 13, 2024
@delucchi-cmu
Copy link
Contributor Author

Addressed in #310

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

1 participant