Qiskit / documentation

The documentation content home for https://docs.quantum.ibm.com.
https://docs.quantum.ibm.com
Apache License 2.0
38 stars 81 forks source link

Failure to handle abstract property #2330

Closed Eric-Arellano closed 3 days ago

Eric-Arellano commented 6 days ago

The docs in https://github.com/Qiskit/documentation/pull/2328 have an abstract property. In Sphinx, it renders like this:

Image

In our repo, it renders like this:

Image

abstract property should no be part of the header name. We instead should call it only the attribute name, and then set something like Modifiers: abstract. Probably leave off property, but confirm what we do when it's just a property for an inline class set up with .. autoclass:: rather than one generated with .. autosummary::.

This Sphinx was generated from this code:

    @property
    @abstractmethod
    def evolved_time(self) -> float:
        """Returns the current evolution time."""

    @property
    @abstractmethod
    def conjugate(self) -> bool:
        """Returns whether this time-evolver instance acts on the right-hand side."""
Eric-Arellano commented 3 days ago

This was fixed in closed source.