Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

convert code sh to text to avoid hightlighting in commands #1617

Merged
merged 1 commit into from
Oct 18, 2022

Conversation

1ucian0
Copy link
Member

@1ucian0 1ucian0 commented Oct 18, 2022

Showing snippets of code with highlight is usually a desired thing for readability. However, when terminal commands are highlighted with sh, then it is a bit distracting and does not add much:

Screenshot 2022-10-18 at 11 02 06

So, I suggest to use text in these cases.

Copy link
Member

@jakelishman jakelishman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally don't mind the sh highlighting, but the Powershell ones are clearly wrong with the escape characters. Happy to change it to text.

Comment on lines -43 to 46
.. code:: sh
.. code:: text

python3 -m venv c:\path\to\virtual\environment
c:\path\to\virtual\environment\Scripts\Activate.ps1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one should always have been pwsh presumably, but text seems fine to me too.

@jakelishman jakelishman merged commit b789a86 into Qiskit:master Oct 18, 2022
@1ucian0 1ucian0 deleted the code/sh2text branch October 18, 2022 13:22
jakelishman pushed a commit to jakelishman/qiskit-terra that referenced this pull request Aug 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants