Skip to content

DOC: fix formatting of shell commands #131295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

DOC: fix formatting of shell commands #131295

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97088bc
fix formatting of shell commands
partev Mar 15, 2025
99af52f
use shell-session instead of shell
partev Mar 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions Doc/using/unix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,28 @@ Installing IDLE

In some cases, IDLE might not be included in your Python installation.

* For Debian and Ubuntu users::
* For Debian and Ubuntu users:

.. code-block:: shell
Copy link
Member

Choose a reason for hiding this comment

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

Do we use shell or bash in general? also are you interested in fixing the other places which use incorrect highlighting?


sudo apt update
sudo apt install idle

* For Fedora, RHEL, and CentOS users::
* For Fedora, RHEL, and CentOS users:

.. code-block:: shell

sudo dnf install python3-idle

* For SUSE and OpenSUSE users::
* For SUSE and OpenSUSE users:

.. code-block:: shell

sudo zypper in python3-idle
Copy link
Member

Choose a reason for hiding this comment

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

As I said, this will still be highlighted as in is a valid shell keyword :( so let's use install.

Suggested change
sudo zypper in python3-idle
sudo zypper install python3-idle

Copy link
Contributor Author

Choose a reason for hiding this comment

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

what if we use shell-session lexer?

Copy link
Member

Choose a reason for hiding this comment

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

The shell-session lexer seems to work but if we put a prompt (say $) in front of the command, it doesn't work. So I'm not sure what would be the best:

image

@hugovk what do you recommend here? I think it's not the only place where we're probably mixing lexers but I think it's better if we don't highlight in here. But using shell-session without a prompt looks a bit... weird =/

Copy link
Member

Choose a reason for hiding this comment

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

Let's use install like in the Zypper docs:

https://documentation.suse.com/smart/systems-management/html/concept-zypper/index.html#general-usage-zypper


* For Alpine Linux users::
* For Alpine Linux users:

.. code-block:: shell

sudo apk add python3-idle

Expand Down
Loading