Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some doc formatting and link, mostly on quantumcircuit.py file #9771

Merged
merged 13 commits into from
Mar 16, 2023
8 changes: 7 additions & 1 deletion qiskit/circuit/bit.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,13 @@


class Bit:
"""Implement a generic bit."""
"""Implement a generic bit.

.. note::
This class should be instantiated directly, but just a super class
1ucian0 marked this conversation as resolved.
Show resolved Hide resolved
for :class:`~.Clbit` and :class:`~.Qubit`.

"""

__slots__ = {"_register", "_index", "_hash", "_repr"}

Expand Down
8 changes: 7 additions & 1 deletion qiskit/circuit/register.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,13 @@ def __get__(self, obj, objtype=None):


class Register:
"""Implement a generic register."""
"""Implement a generic register.

.. note::
This class should be instantiated directly, but just a super class
1ucian0 marked this conversation as resolved.
Show resolved Hide resolved
for :class:`~.ClassicalRegister` and :class:`~.QuantumRegister`.

"""

__slots__ = ["_name", "_size", "_bits", "_bit_indices", "_hash", "_repr"]

Expand Down