Skip to content

Commit 8a0138f

Browse files
authored
Small doc fixes (#1770)
- missing notebooks from toc - reference doc warnings
1 parent 7f2b156 commit 8a0138f

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

dev_tools/qualtran_dev_tools/make_reference_docs/_make.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@
7373
'qualtran.linalg',
7474
'qualtran._infra.gate_with_registers.GateWithRegisters',
7575
'qualtran.resource_counting.t_counts_from_sigma',
76+
'qualtran.rotation_synthesis', # TODO: https://github.com/quantumlib/Qualtran/issues/1767
7677
]
7778
MINIMAL = True
7879

@@ -341,7 +342,7 @@ def make_reference_docs(
341342
The steps are
342343
343344
1. Walk the package structure with `get_pages`.
344-
2. Write each page; and write the table of contentes (TOC).
345+
2. Write each page; and write the table of contents (TOC).
345346
346347
There are multiple 'types' of 'path's we must consider when rendering the documentation.
347348

docs/bloq_infra.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ types (``Register``), and algorithms (``CompositeBloq``).
2424
DataTypes.ipynb
2525
simulation/classical_sim.ipynb
2626
simulation/tensor.ipynb
27+
simulation/MBUC.ipynb
28+
simulation/supertensor.ipynb
2729
resource_counting/call_graph.ipynb
2830
resource_counting/qubit_counts.ipynb
2931
Adjoint.ipynb

qualtran/rotation_synthesis/channels/channel.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ def from_sequence(cls, seq: Sequence[str], twirl: bool = False) -> UnitaryChanne
103103
104104
Args:
105105
seq: A sequence of gate names in circuit order.
106-
Supported gate names are {Tx, Ty, Tz, H, S, X, Y, Z}.
106+
Supported gate names are {Tx, Ty, Tz, H, S, X, Y, Z}.
107107
twirl: Whether the unitary is applied with a ZS twirling or not.
108108
109109
Returns:

qualtran/rotation_synthesis/rings/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"""A sub-package represnting the rings used in rotation synthesis."""
15+
"""A sub-package representing the rings used in rotation synthesis."""
1616

1717
from qualtran.rotation_synthesis.rings.zsqrt2 import ZSqrt2
1818
from qualtran.rotation_synthesis.rings.zw import ZW

0 commit comments

Comments
 (0)