Small doc formatting issues #10574

1ucian0 · 2023-08-04T19:16:32Z

Some small formatting issues in docstring found around.

…ge_docs/3

qiskit-bot · 2023-08-04T19:16:35Z

One or more of the the following people are requested to review this:

@enavarro51
@Qiskit/terra-core

coveralls · 2023-08-04T19:52:16Z

Pull Request Test Coverage Report for Build 5866793708

2 of 2 (100.0%) changed or added relevant lines in 2 files are covered.
247 unchanged lines in 19 files lost coverage.
Overall coverage increased (+0.007%) to 87.251%

Files with Coverage Reduction	New Missed Lines	%
qiskit/exceptions.py	1	96.15%
qiskit/qasm2/init.py	2	93.33%
qiskit/qpy/exceptions.py	2	66.67%
crates/qasm2/src/lex.rs	3	91.39%
qiskit/transpiler/passes/utils/block_to_matrix.py	3	83.33%
qiskit/algorithms/amplitude_estimators/ae.py	4	93.94%
qiskit/circuit/init.py	4	84.85%
qiskit/transpiler/preset_passmanagers/builtin_plugins.py	4	97.04%
qiskit/transpiler/preset_passmanagers/level0.py	4	93.75%
qiskit/transpiler/preset_passmanagers/level1.py	4	96.49%

Totals
Change from base Build 5787606820:	0.007%
Covered Lines:	74292
Relevant Lines:	85147

💛 - Coveralls

…ge_docs/3

Cryoris · 2023-08-14T14:42:47Z

qiskit/circuit/gate.py

            label: optional gate label
            ctrl_state: The control state in decimal or as a bitstring
-                (e.g. '111'). If None, use 2**num_ctrl_qubits-1.
+                (e.g. ``'111'``). If None, use 2**``num_ctrl_qubits``-1.


It might be nicer to also wrap the ** in code, since it's also Python syntax

Suggested change

(e.g. ``'111'``). If None, use 2**``num_ctrl_qubits``-1.

(e.g. ``'111'``). If None, use ``2**num_ctrl_qubits - 1``.

You are right. Things in this entry need another pass. Checked in a504bb0

Cryoris · 2023-08-14T14:44:10Z

qiskit/converters/circuit_to_dag.py

@@ -17,7 +17,7 @@


 def circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None):
-    """Build a ``DAGCircuit`` object from a ``QuantumCircuit``.
+    """Build a :class:`~.DAGCircuit` object from a :class:`~.QuantumCircuit`.


Just a note, the leading ~ is not needed here as this simply truncates the path of the object. Since here there's no path, as you just used .<Object>, there's nothing to truncate (but it's not harmful afaik so no need to change) 🙂

qiskit/extensions/quantum_initializer/squ.py

qiskit/circuit/gate.py

Co-authored-by: Julien Gacon <[email protected]>

qiskit/extensions/quantum_initializer/squ.py

Co-authored-by: Julien Gacon <[email protected]>

coveralls · 2023-08-28T10:27:04Z

Pull Request Test Coverage Report for Build 5998056952

2 of 2 (100.0%) changed or added relevant lines in 2 files are covered.
6 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.001%) to 87.281%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	3	91.65%
qiskit/pulse/library/waveform.py	3	93.75%

Totals
Change from base Build 5985235181:	0.001%
Covered Lines:	74286
Relevant Lines:	85111

💛 - Coveralls

qiskit/converters/circuit_to_dag.py

qiskit/execute_function.py

1ucian0 · 2023-09-14T14:01:19Z

Thanks for your comments, @Cryoris

I think I addressed them all.

jakelishman · 2023-09-14T16:28:31Z

qiskit/dagcircuit/__init__.py

+DAG (directed acyclic graph) Circuits
+=====================================


It's unusual to put the definition of an acronym in a title. Probably a bit better to say it as:

DAG Circuits

Quantum operations in the absence of control-flow operations can be represented by a directed acyclic graph (DAG).
...

or have the title as "Circuits as Directed Acyclic Graphs" and define the "DAG" acronym in the prose.

done in 430d0b3

jakelishman · 2023-09-14T16:29:29Z

qiskit/dagcircuit/dagdependency.py

-    """Object to represent a quantum circuit as a directed acyclic graph
+    """Object to represent a quantum circuit as a DAG


Personally I think using the full text here was clearer, but I don't feel strongly.

done in 16b75c7

jakelishman · 2023-09-14T16:36:00Z

qiskit/visualization/pass_manager_visualization.py

-    This function needs `pydot <https://github.com/erocarrera/pydot>`__, which in turn needs
-    `Graphviz <https://www.graphviz.org/>`__ to be installed.
+    This function needs `pydot <https://github.com/pydot/pydot>`_, which in turn needs
+    `Graphviz <https://www.graphviz.org/>`_ to be installed.


The double underscore is also fine here - the single creates a named hyperlink (so you could later use <Graphviz_> as if it was the URL and it'd alias the first one), while the double doesn't allow the re-use. The docs are here: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases.

No need to change anything here - both are fine - just pointing out that you don't need to worry about this in the future.

always learning new things. reverting in c6af56c so the diff is cleaner.

…ge_docs/3

qiskit/dagcircuit/dagdependency.py

* small doc fixes * more small changes * Update qiskit/extensions/quantum_initializer/squ.py Co-authored-by: Julien Gacon <[email protected]> * improve gate docs * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * Update qiskit/converters/circuit_to_dag.py * Update qiskit/execute_function.py * Circuits as Directed Acyclic Graphs * a quantum circuit as a Directed Acyclic Graphs (DAG * __ * Fix errant plural --------- Co-authored-by: Julien Gacon <[email protected]> Co-authored-by: Jake Lishman <[email protected]> (cherry picked from commit d3a6172)

* small doc fixes * more small changes * Update qiskit/extensions/quantum_initializer/squ.py Co-authored-by: Julien Gacon <[email protected]> * improve gate docs * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * Update qiskit/converters/circuit_to_dag.py * Update qiskit/execute_function.py * Circuits as Directed Acyclic Graphs * a quantum circuit as a Directed Acyclic Graphs (DAG * __ * Fix errant plural --------- Co-authored-by: Julien Gacon <[email protected]> Co-authored-by: Jake Lishman <[email protected]> (cherry picked from commit d3a6172) Co-authored-by: Luciano Bello <[email protected]>

1ucian0 added 3 commits August 3, 2023 10:50

small doc fixes

ccf0c02

Merge branch 'main' of github.com:Qiskit/qiskit-terra into small_chan…

c46ca8f

…ge_docs/3

Merge branch 'main' of github.com:Qiskit/qiskit-terra into small_chan…

de1ff79

…ge_docs/3

1ucian0 requested review from nonhermitian and a team as code owners August 4, 2023 19:16

1ucian0 added 3 commits August 7, 2023 10:51

Merge branch 'main' of github.com:Qiskit/qiskit-terra into small_chan…

e202f57

…ge_docs/3

more small changes

6284431

Merge branch 'main' of github.com:Qiskit/qiskit-terra into small_chan…

1587f82

…ge_docs/3

Cryoris reviewed Aug 14, 2023

View reviewed changes

1ucian0 and others added 2 commits August 15, 2023 13:58

Update qiskit/extensions/quantum_initializer/squ.py

d1836a9

Co-authored-by: Julien Gacon <[email protected]>

improve gate docs

a504bb0

Cryoris reviewed Aug 16, 2023

View reviewed changes

qiskit/extensions/quantum_initializer/squ.py Outdated Show resolved Hide resolved

Cryoris reviewed Aug 16, 2023

View reviewed changes

qiskit/extensions/quantum_initializer/squ.py Outdated Show resolved Hide resolved

1ucian0 and others added 2 commits August 17, 2023 09:45

Apply suggestions from code review

d9aed42

Co-authored-by: Julien Gacon <[email protected]>

Merge branch 'main' into small_change_docs/3

6e7c566

1ucian0 commented Sep 14, 2023

View reviewed changes

qiskit/converters/circuit_to_dag.py Outdated Show resolved Hide resolved

Update qiskit/converters/circuit_to_dag.py

468f8ee

1ucian0 commented Sep 14, 2023

View reviewed changes

qiskit/execute_function.py Outdated Show resolved Hide resolved

Update qiskit/execute_function.py

6edba2b

jakelishman reviewed Sep 14, 2023

View reviewed changes

1ucian0 added 4 commits September 16, 2023 23:16

Merge branch 'main' of github.com:Qiskit/qiskit-terra into small_chan…

86c9d37

…ge_docs/3

Circuits as Directed Acyclic Graphs

430d0b3

a quantum circuit as a Directed Acyclic Graphs (DAG

16b75c7

__

c6af56c

jakelishman previously approved these changes Sep 18, 2023

View reviewed changes

qiskit/dagcircuit/dagdependency.py Outdated Show resolved Hide resolved

jakelishman dismissed their stale review via 10ccfb9 September 18, 2023 11:50

Fix errant plural

10ccfb9

jakelishman approved these changes Sep 18, 2023

View reviewed changes

jakelishman enabled auto-merge September 18, 2023 11:50

jakelishman added documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable Changelog: None Do not include in changelog labels Sep 18, 2023

Merge branch 'main' into small_change_docs/3

4c5a033

jakelishman added this pull request to the merge queue Sep 22, 2023

Merged via the queue into Qiskit:main with commit d3a6172 Sep 22, 2023
13 of 15 checks passed

mergify bot mentioned this pull request Sep 22, 2023

Small doc formatting issues (backport #10574) #10885

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Small doc formatting issues #10574

Small doc formatting issues #10574

1ucian0 commented Aug 4, 2023

qiskit-bot commented Aug 4, 2023

coveralls commented Aug 4, 2023 •

edited

Loading

Cryoris Aug 14, 2023

1ucian0 Aug 16, 2023

Cryoris Aug 14, 2023

1ucian0 Sep 16, 2023

1ucian0 Sep 16, 2023

coveralls commented Aug 28, 2023

1ucian0 commented Sep 14, 2023

jakelishman Sep 14, 2023

1ucian0 Sep 16, 2023 •

edited

Loading

jakelishman Sep 14, 2023

1ucian0 Sep 16, 2023 •

edited

Loading

jakelishman Sep 14, 2023

1ucian0 Sep 16, 2023

	(e.g. ``'111'``). If None, use 2**``num_ctrl_qubits``-1.
	(e.g. ``'111'``). If None, use ``2**num_ctrl_qubits - 1``.

		DAG (directed acyclic graph) Circuits
		=====================================

		"""Object to represent a quantum circuit as a directed acyclic graph
		"""Object to represent a quantum circuit as a DAG

Small doc formatting issues #10574

Small doc formatting issues #10574

Conversation

1ucian0 commented Aug 4, 2023

qiskit-bot commented Aug 4, 2023

coveralls commented Aug 4, 2023 • edited Loading

Pull Request Test Coverage Report for Build 5866793708

💛 - Coveralls

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

coveralls commented Aug 28, 2023

Pull Request Test Coverage Report for Build 5998056952

💛 - Coveralls

1ucian0 commented Sep 14, 2023

Choose a reason for hiding this comment

1ucian0 Sep 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ucian0 Sep 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Aug 4, 2023 •

edited

Loading

1ucian0 Sep 16, 2023 •

edited

Loading

1ucian0 Sep 16, 2023 •

edited

Loading