Skip to content

plum-dispatch functions don't render well in the documentation #50

Open
@garrison

Description

See rendering at https://docs.quantum.ibm.com/api/qiskit-addon-aqc-tensor/simulation

Bugs with the Sphinx output

  • Type annotations are fully qualified, unnecessarily. E.g., will say qiskit_addon_aqc_tensor.simulation.aer.state.QiskitAerMPS instead of QiskitAerMPS.
  • The "parameters" and "return type" for each method should be removed. They're not even correct currently. Instead, probably the best solution is to have them be listed once per function (instead of for each method, too).
  • each method is given a [source] link, but all of them link to the "abstract" method's source code. Ideally, it would link to the correct method in each case.

Additional bugs with docs.quantum.ibm.com rendering

  • The type annotations are clickable links in the Sphinx output, but they are no longer clickable when rendered on docs.quantum.ibm.com.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions