Minor docs updates #181
Minor docs updates #181
Conversation
|
Fixes #204 (also). |
Misty-W
changed the title
docs/source/user_guide.rst
Outdated
| @@ -30,7 +30,7 @@ For example, we can define a random circuit in Qiskit and optimize it using the | |||
|
|
|||
| from qiskit.circuit.random import random_clifford_circuit | |||
| import ucc | |||
| from ucc.benchmarks.utils import count_multi_qubit_gates_qiskit | |||
| from benchmarks.utils import count_multi_qubit_gates_qiskit | |||
There was a problem hiding this comment.
For me, I had to switch this to from benchmarks.scripts.common as the utils submodule didn't exist.
But also curious, do we want benchmarks to be a submodule of ucc or a sibling?
There was a problem hiding this comment.
Thanks Brad. I think it's more intuitive to have benchmarks as a submodule of ucc. I think the benchmarks module was intentionally made a sibling of ucc during earlier restructuring of the library, but I don't remember the reason. Jordan likely has more context.
| UCC requires Python version :math:`\ge` 3.12. | ||
| UCC requires Python version ≥ 3.12. |
There was a problem hiding this comment.
No problem from me, but why does this need to change? Seems to be rendering fine: https://ucc.readthedocs.io/en/latest/user_guide.html
There was a problem hiding this comment.
Yep RTD is fine either way, but it didn't render in the Markdown preview on our GitHub 😐
Originally opened to update readme with python version requirement and fix rendering of that requirement in the user guide.
Also fixes import in #204 - import from
benchmarkingnotucc.benchmarking