search

Qiskit / documentation

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

Remove >>> from code blocks #2072

Open Eric-Arellano opened 1 month ago

Eric-Arellano commented 1 month ago

It's common to see code blocks like this:

>>> 1 + 1
2

The >>> is emulating a REPL like IPython. However, it's not very useful to our end users because they cannot use our copy-code button. Better is this:

print(1 + 1)
2

We should fix:

Use rg '>>>' to find violations.

In Sphinx, you'd fix this with something like this:

.. code-block:: python

  print(1 + 1)

.. code-block:: text

  2
a-dubaj commented 1 month ago

Hi, can you assigned me to this issue please?

Eric-Arellano commented 1 month ago

Sure, @a-dubaj. Thanks for offering to help! It'd be great to focus on docs/guides and docs/migration-guides to start. The API docs are updated in other repositories and could be handled separately.

Eric-Arellano commented 4 weeks ago

Hey @a-dubaj how is this going?