Qiskit / documentation

The documentation content home for https://docs.quantum.ibm.com.
https://docs.quantum.ibm.com
Apache License 2.0
38 stars 81 forks source link

docs: update algorithmiq-tem notebook #2281

Closed robertodr closed 1 week ago

qiskit-bot commented 1 week ago

Thanks for contributing to Qiskit documentation!

Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌

One or more of the following people are relevant to this code:

review-notebook-app[bot] commented 1 week ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

robertodr commented 1 week ago

~I have no idea how to fix the lint...~ I think I figured it out

Eric-Arellano commented 1 week ago

@robertodr there are two issues:

You can use this diff to fix things. FYI you can save the diff in a file like review-changes.patch, then run git apply review-changes.patch.

diff --git a/docs/guides/algorithmiq-tem.ipynb b/docs/guides/algorithmiq-tem.ipynb
index 95369207cd..dbbaf96036 100644
--- a/docs/guides/algorithmiq-tem.ipynb
+++ b/docs/guides/algorithmiq-tem.ipynb
@@ -177,7 +177,9 @@
     "pub = (qc, [observable])\n",
     "options = {\"default_precision\": 0.02}\n",
     "\n",
-    "job = tem.run(pubs=[pub], instance=instance, backend_name=backend_name, options=options)"
+    "job = tem.run(\n",
+    "    pubs=[pub], instance=instance, backend_name=backend_name, options=options\n",
+    ")"
    ]
   },
   {
@@ -244,13 +246,12 @@
     "\n",
     "\n",
     "<Admonition type=\"caution\">\n",
-    "TEM currently has the following limitations:\n",
-    "<ul>\n",
-    "  <li>Parametrized circuits are not supported. The parameters argument should be set to <tt>None</tt> if precision is specified.</li>\n",
-    "  <li>Only circuits with linear connectivity are supported. This restriction will be removed in future versions.</li>\n",
-    "  <li>Non-unitary gates, such as reset, measure, and all forms of control flow are not supported. Support for reset will be added in upcoming releases.</li>\n",
-    "</ul> \n",
-    "</Admonition>\n"
+    "  TEM currently has the following limitations:\n",
+    "\n",
+    "  - Parametrized circuits are not supported. The parameters argument should be set to `None` if precision is specified.\n",
+    "  - Only circuits with linear connectivity are supported. This restriction will be removed in future versions.\n",
+    "  - Non-unitary gates, such as reset, measure, and all forms of control flow are not supported. Support for reset will be added in upcoming releases.\n",
+    "</Admonition>"
    ]
   },
   {

The warning will render like this, which you can preview by running ./start in this repo.

Screenshot 2024-11-12 at 9 16 05 AM
Eric-Arellano commented 1 week ago

Thanks for the fix! We will do a deploy later today to docs.quantum.ibm.com.