Attributes section header is going in the incorrect place
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
For some of the Circuit Library functions, the parameters for the class constructor appear underneath the header "Attributes". This happens in both Sphinx and our repository, such as the 1.3 docs for qiskit.circuit.library.PhaseGate.
Note that these parameters don't have any docstring associated with them. This problem was detected in https://github.com/Qiskit/documentation/pull/2418, which adds parameters with no docstring. Maybe this happens in that specific edge case where there aren't documented parameters?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the PhaseGate output in the 1.3 docs and compare the Sphinx result with the repository-rendered result. Inspect the documentation change from pull request 2418, especially the case where constructor parameters have no docstrings; done means those parameters no longer appear under the Attributes header in either output.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100