Fix broken docstrings in bindings and minor API docs updates #920

CalMacCQ · 2023-07-07T13:46:33Z

Fix missing/broken docstrings in various places

This fixes the docstrings for RoundAngles, ZZPhaseToRz, Routingpass, CustomRoutingPass, Bit.to_list(), NoiseAwarePlacement.to_dict(), ZXDiagram.get_boundary() some stuff in pytket.pauli as well

This PR also updates the docs for pytket.qasm and fixes the misleading docstring for ZZPhaseToRz

There were some issues with my local build not matching the html pages built on CI but these seem to be resolved now

I have checked everything with sphinx==6.1.3 and it seems to work. This seems to be the verison used in CI.

See the issue #916

…d_angles

cqc-alec · 2023-07-07T17:13:53Z

pytket/binders/passes.cpp


  m.def(
      "CnXPairwiseDecomposition", &CnXPairwiseDecomposition,
-      "Decompose CnX gates to 2-qubit gates and single qubit gates. "
+      "Decompose CnX gates to 2-qubit gates and single qubit gates."


This space was needed,

cqc-alec · 2023-07-07T17:15:39Z

pytket/binders/passes.cpp

-      "Round angles to the nearest :math:`\\pi / 2^n`."
-      "\n\n:param n: precision parameter, must be >= 0 and < 32",
-      "\n\n:param only_zeros: if True, only round angles less than "
+      "Round angles to the nearest :math:`\\pi / 2^n`. "


Can't actually see what the problem was with this one.

…d_angles

CalMacCQ · 2023-07-21T15:08:54Z

pytket/docs/getting_started.rst

@@ -93,7 +93,7 @@ This prints out a summary of readouts (the final values of the classical bits) a

 Each pytket :py:class:`Backend` comes with its own default compilation method. This is a recommended sequence of optimisation passes to meet the requirements of the specific :py:class:`Backend`. 

-The following code snippet will show how to compile a circuit to run on an IBM device. This requires setting up IBM credentials (see `this page <https://cqcl.github.io/pytket-qiskit/api/index.html#access-and-credentials>`).
+The following code snippet will show how to compile a circuit to run on an IBM device. This requires setting up IBM credentials (see the `credentials guide <https://cqcl.github.io/pytket-qiskit/api/index.html#access-and-credentials>`_).


changed this to avoid the duplicate link labelled "this page". Fixes a sphinx warning

cqc-melf

Few comments, have you checked the CI build docs as well?

cqc-melf · 2023-07-21T15:55:29Z

pytket/docs/qasm.rst

@@ -1,16 +1,24 @@
 pytket.qasm
 ==================================
 :py:class:`Circuit` objects can be converted to and from OpenQASM, although we do not support all operations.
-In particular, we do not currently support:
+In particular, we do not currently support the ability to interpret gates acting on a whole register in the OpenQASM style.


Are you sure this is true? I thought we can do this with classical ops?

So this line was there before. I just removed the first bullet point which outdated. I just removed the first bullet point and added the second bullet point to the paragraph above.

If this line is also outdated we should remove this

I think we should remove both. It is a bit misleading from my understanding

I've removed this line

cqc-melf · 2023-07-21T15:57:50Z

pytket/binders/passes.cpp

@@ -855,8 +859,12 @@ PYBIND11_MODULE(passes, m) {

  m.def(
      "ZZPhaseToRz", &ZZPhaseToRz,
-      "Converts ZZPhase gates with angle pi or -pi to two Rz gates with"
-      "angle pi.\n:return: a pass to convert ZZPhase gates to Rz");
+      "Converts all ZZPhase gates in a circuit with angle 1 or -1 (radians) "


Suggested change

"Converts all ZZPhase gates in a circuit with angle 1 or -1 (radians) "

"Converts all ZZPhase gates in a circuit with angle 1 or -1 (half turns) "

1 radian is a half turn. The angle convention is that the 1 refers to the number of half turns. I can say "half turns" if preferred

I think half turns would be good 👍

I have updated the suggestion

cqc-melf · 2023-07-21T15:58:14Z

pytket/binders/passes.cpp

-      "Converts ZZPhase gates with angle pi or -pi to two Rz gates with"
-      "angle pi.\n:return: a pass to convert ZZPhase gates to Rz");
+      "Converts all ZZPhase gates in a circuit with angle 1 or -1 (radians) "
+      "into two Rz gates each with a parameter value of 1 (radians). "


Suggested change

"into two Rz gates each with a parameter value of 1 (radians). "

"into two Rz gates each with a parameter value of 1 (half turns). "

I have updated the suggestion

cqc-melf · 2023-07-21T15:58:30Z

pytket/binders/passes.cpp

+      "Converts all ZZPhase gates in a circuit with angle 1 or -1 (radians) "
+      "into two Rz gates each with a parameter value of 1 (radians). "
+      "ZZPhase gates with parameter values other than 1 or -1 "
+      "(radians) are left "


Suggested change

"(radians) are left "

"(half turns) are left "

I have updated the suggestion

CalMacCQ · 2023-07-21T17:38:45Z

pytket/docs/display.rst

@@ -21,7 +21,7 @@ Example usage:
    from pytket.circuit.display import get_circuit_renderer

    circuit_renderer = get_circuit_renderer() # Instantiate a circuit renderer
-    circuit_renderer.set_render_options(zx_style=False) # Configure render options
+    circuit_renderer.set_render_options(zx_style=True) # Configure render options


This is because the renderer no longer uses ZX by default

fix RenameQubitsPass docs

6da46b0

CalMacCQ changed the title ~~fix RenameQubitsPass docs~~ Fix broken docstrings in bindings Jul 7, 2023

CalMacCQ added 2 commits July 7, 2023 15:11

try to fix ZZPhaseToRz, RoutingPass and CustomRoutingPass

e1244c2

Merge branch 'develop' into fix/round_angles

cc955c5

CalMacCQ marked this pull request as draft July 7, 2023 14:21

CalMacCQ added 4 commits July 7, 2023 15:34

Merge branch 'develop' into fix/round_angles

820e72f

Merge branch 'fix/round_angles' of github.com:CQCL/tket into fix/roun…

00ac411

…d_angles

try to fix RoundAngles

d3f69a0

finally fix ZZPhaseToRz

0976cdd

CalMacCQ marked this pull request as ready for review July 7, 2023 16:08

CalMacCQ requested a review from cqc-alec July 7, 2023 16:09

cqc-alec reviewed Jul 7, 2023

View reviewed changes

CalMacCQ added 15 commits July 7, 2023 20:27

fix spacing

fe50e09

Merge branch 'develop' into fix/round_angles

7a00e59

fix RingArch and to_dict

c142330

fix QubitPauliString

e6b9213

fix spacing

e5fbf5f

fix spacing in ZZPhaseToRz

233c184

use sphinx-autodoc-typehints

20eaf62

Merge branch 'fix/round_angles' of github.com:CQCL/tket into fix/roun…

e9b478a

…d_angles

fix broken getting_started links

a5c3df4

fix mistake in ZZPhaseToRz docstring

98aed47

use sphinx_autodoc_annotation again

3d676e6

update ZZPhaseToRz docstring

6ff580c

fix conf.py

9458e3c

fix duplicate link warning

38e4cbf

Merge branch 'develop' into fix/round_angles

02ea72c

CalMacCQ commented Jul 21, 2023

View reviewed changes

CalMacCQ added 2 commits July 21, 2023 16:25

update pytket.qasm docs

35c5741

minor wording

d227dc5

CalMacCQ requested a review from cqc-melf July 21, 2023 15:39

cqc-melf reviewed Jul 21, 2023

View reviewed changes

CalMacCQ added 5 commits July 21, 2023 17:41

remove extra lines from pytket.qasm docs

e1415dd

more pytket.qasm edits

b354c4c

use half-turns instead of radians

d7244b9

fix Bit.to_list() docstring

6d1fa51

fix minor formatting issues in pytket.placement and pytket.zx

c258c77

CalMacCQ commented Jul 21, 2023

View reviewed changes

CalMacCQ requested a review from cqc-melf July 21, 2023 17:38

CalMacCQ changed the title ~~Fix broken docstrings in bindings~~ Fix broken docstrings in bindings and minor API docs updates Jul 21, 2023

cqc-melf approved these changes Jul 24, 2023

View reviewed changes

CalMacCQ merged commit 67b323d into develop Jul 24, 2023
34 checks passed

CalMacCQ deleted the fix/round_angles branch July 24, 2023 13:46

CalMacCQ mentioned this pull request Jul 24, 2023

Docstring for RoundAngles pass not appearing in generated docs #916

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix broken docstrings in bindings and minor API docs updates #920

Fix broken docstrings in bindings and minor API docs updates #920

CalMacCQ commented Jul 7, 2023 •

edited

Loading

cqc-alec Jul 7, 2023

cqc-alec Jul 7, 2023

CalMacCQ Jul 21, 2023 •

edited

Loading

cqc-melf left a comment

cqc-melf Jul 21, 2023

CalMacCQ Jul 21, 2023 •

edited

Loading

cqc-melf Jul 21, 2023

CalMacCQ Jul 21, 2023

cqc-melf Jul 21, 2023 •

edited

Loading

CalMacCQ Jul 21, 2023 •

edited

Loading

cqc-melf Jul 21, 2023

cqc-melf Jul 21, 2023

CalMacCQ Jul 21, 2023

cqc-melf Jul 21, 2023 •

edited

Loading

CalMacCQ Jul 21, 2023

cqc-melf Jul 21, 2023

CalMacCQ Jul 21, 2023

cqc-melf Jul 21, 2023 •

edited

Loading

CalMacCQ Jul 21, 2023

cqc-melf Jul 21, 2023

CalMacCQ Jul 21, 2023

CalMacCQ Jul 21, 2023

	"Converts all ZZPhase gates in a circuit with angle 1 or -1 (radians) "
	"Converts all ZZPhase gates in a circuit with angle 1 or -1 (half turns) "

	"into two Rz gates each with a parameter value of 1 (radians). "
	"into two Rz gates each with a parameter value of 1 (half turns). "

Fix broken docstrings in bindings and minor API docs updates #920

Fix broken docstrings in bindings and minor API docs updates #920

Conversation

CalMacCQ commented Jul 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CalMacCQ Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

cqc-melf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CalMacCQ Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cqc-melf Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

CalMacCQ Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cqc-melf Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cqc-melf Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CalMacCQ commented Jul 7, 2023 •

edited

Loading

CalMacCQ Jul 21, 2023 •

edited

Loading

CalMacCQ Jul 21, 2023 •

edited

Loading

cqc-melf Jul 21, 2023 •

edited

Loading

CalMacCQ Jul 21, 2023 •

edited

Loading

cqc-melf Jul 21, 2023 •

edited

Loading

cqc-melf Jul 21, 2023 •

edited

Loading