Qiskit API docs methods sections without methods
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
There are pages for qiskit 0.19 (to be determined if it affects to more versions) where we have a header for a methods section that is currently empty. Look at this page for an example.
I suspect that this is caused because the HTML has an empty table. This is an example of qiskit.scheduler.ScheduleConfig:
<p class="rubric">Methods</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
</tbody>
</table>
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 with the linked qiskit 0.19 BackendJobLimit API page and inspect the generated HTML for the empty Methods table. Compare it with the ScheduleConfig example to identify where the empty section is produced and check whether other versions are affected. Done means affected pages no longer show empty Methods headings.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100