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

Fix class attribute documentation generation #1078

Open
coruscating opened this issue Mar 14, 2023 · 5 comments
Open

Fix class attribute documentation generation #1078

coruscating opened this issue Mar 14, 2023 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@coruscating
Copy link
Collaborator

The default class template behavior for documenting attributes needs to be updated. For example, when docstrings are written for class variables, the docs render both the docstring content and the variables as links to empty pages:

image

We should enforce documenting these variables in docstrings and not render them in the attributes section. The solution in #983 is to skip them manually in conf.py, but there should be a way to automatically ignore them.

@coruscating coruscating added the documentation Improvements or additions to documentation label Mar 14, 2023
@nitin-pandita
Copy link

I would love to contribute , can you assign this to me @coruscating

@coruscating
Copy link
Collaborator Author

@nitin-pandita Have you started working on this? Happy to assign it to you if you're still interested.

Another issue that needs fixing is classes that inherit from a built-in class, for example dict, renders built-in methods that are not helpful: https://qiskit.org/ecosystem/experiments/stubs/qiskit_experiments.visualization.PlotStyle.html

Ideally these should not be rendered.

@nitin-pandita
Copy link

@nitin-pandita Have you started working on this? Happy to assign it to you if you're still interested.

Another issue that needs fixing is classes that inherit from a built-in class, for example dict, renders built-in methods that are not helpful: https://qiskit.org/ecosystem/experiments/stubs/qiskit_experiments.visualization.PlotStyle.html

Ideally these should not be rendered.

I would love to work on it, just need a time extension , busy with my semester exams. Hope you understand

@coruscating
Copy link
Collaborator Author

@nitin-pandita No worries, there's no rush.

@nitin-pandita
Copy link

@nitin-pandita No worries, there's no rush.

Thank you, i will try my best to complete it as soon as possible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants