Skip to content

Commit ad05712

Browse files
authored
Merge pull request #957 from apjanke/doscon-styling
Format Windows console examples with `doscon`or `powershell`
2 parents 1ad8877 + d200bf0 commit ad05712

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

docs/notes/styleguide.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,10 @@ Command line examples:
109109
$ run command --help
110110
$ ls ..
111111
112-
Be sure to include the ``$`` prefix before each line.
112+
Be sure to include the ``$`` prefix before each line for Unix console examples.
113+
114+
For Windows console examples, use ``doscon`` or ``powershell`` instead of
115+
``console``, and omit the ``$`` prefix.
113116

114117
Python interpreter examples:
115118

docs/starting/install/win.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ tedious, so add the directories for your default Python version to the :envvar:`
3232
Assuming that your Python installation is in :file:`C:\\Python27\\`, add this to your
3333
:envvar:`PATH`:
3434

35-
.. code-block:: console
35+
.. code-block:: doscon
3636
3737
C:\Python27\;C:\Python27\Scripts\
3838
3939
You can do this easily by running the following in ``powershell``:
4040

41-
.. code-block:: console
41+
.. code-block:: powershell
4242
4343
[Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Python27\;C:\Python27\Scripts\", "User")
4444
@@ -68,9 +68,9 @@ pip by default.
6868

6969
To see if pip is installed, open a command prompt and run
7070

71-
.. code-block:: console
71+
.. code-block:: doscon
7272
73-
$ command -v pip
73+
command -v pip
7474
7575
To install pip, `follow the official pip installation guide <https://pip.pypa.io/en/latest/installing/>`_ - this will automatically install the latest version of setuptools.
7676

docs/starting/install3/win.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It's a community system packager manager for Windows 7+. (It's very much like Ho
1212

1313
Once done, installing Python 3 is very simple, because Chocolatey pushes Python 3 as the default.
1414

15-
.. code-block:: console
15+
.. code-block:: doscon
1616
1717
choco install python
1818
@@ -29,7 +29,9 @@ which let you download, install and uninstall any compliant Python software
2929
product with a single command. It also enables you to add this network installation
3030
capability to your own Python software with very little work.
3131

32-
All supported versions of Python 3 include pip, so just make sure it's up to date::
32+
All supported versions of Python 3 include pip, so just make sure it's up to date:
33+
34+
.. code-block:: doscon
3335
3436
python -m pip install -U pip
3537

0 commit comments

Comments
 (0)