Open coruscating opened 1 year ago
I would love to contribute , can you assign this to me @coruscating
@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 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
@nitin-pandita No worries, there's no rush.
@nitin-pandita No worries, there's no rush.
Thank you, i will try my best to complete it as soon as possible
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:
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.