Merge pull request #21249 from anntzer/sh

timhoffm · web-flow · commit 01fa307a20bf · 2021-10-01T18:45:24.000+02:00
Fix some syntax highlights in coding and contributing guide.
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -45,10 +45,12 @@ When making a PR, pay attention to:
   on GitHub.
 * When updating your PR, instead of adding new commits to fix something, please
   consider amending your initial commit(s) to keep the history clean.
-  You can achieve this using::
+  You can achieve this using
 
-      git commit --amend --no-edit
-      git push [your-remote-repo] [your-branch] --force-with-lease
+  .. code-block:: bash
+
+     git commit --amend --no-edit
+     git push [your-remote-repo] [your-branch] --force-with-lease
 
 See also :ref:`contributing` for how to make a PR.
 
@@ -352,22 +354,26 @@ the merge notification) or through the git CLI tools.
 
 Assuming that you already have a local branch ``v2.2.x`` (if not, then
 ``git checkout -b v2.2.x``), and that your remote pointing to
-``https://github.com/matplotlib/matplotlib`` is called ``upstream``::
+``https://github.com/matplotlib/matplotlib`` is called ``upstream``:
+
+.. code-block:: bash
 
-  git fetch upstream
-  git checkout v2.2.x  # or include -b if you don't already have this.
-  git reset --hard upstream/v2.2.x
-  git cherry-pick -m 1 TARGET_SHA
-  # resolve conflicts and commit if required
+   git fetch upstream
+   git checkout v2.2.x  # or include -b if you don't already have this.
+   git reset --hard upstream/v2.2.x
+   git cherry-pick -m 1 TARGET_SHA
+   # resolve conflicts and commit if required
 
 Files with conflicts can be listed by ``git status``,
 and will have to be fixed by hand (search on ``>>>>>``).  Once
 the conflict is resolved, you will have to re-add the file(s) to the branch
-and then continue the cherry pick::
+and then continue the cherry pick:
+
+.. code-block:: bash
 
-  git add lib/matplotlib/conflicted_file.py
-  git add lib/matplotlib/conflicted_file2.py
-  git cherry-pick --continue
+   git add lib/matplotlib/conflicted_file.py
+   git add lib/matplotlib/conflicted_file2.py
+   git cherry-pick --continue
 
 Use your discretion to push directly to upstream or to open a PR; be
 sure to push or PR against the ``v2.2.x`` upstream branch, not ``master``!
diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst
@@ -440,11 +440,13 @@ or manually with ::
   logging.basicConfig(level=logging.DEBUG)
   import matplotlib.pyplot as plt
 
-Then they will receive messages like::
+Then they will receive messages like
 
-  DEBUG:matplotlib.backends:backend MacOSX version unknown
-  DEBUG:matplotlib.yourmodulename:Here is some information
-  DEBUG:matplotlib.yourmodulename:Here is some more detailed information
+.. code-block:: none
+
+   DEBUG:matplotlib.backends:backend MacOSX version unknown
+   DEBUG:matplotlib.yourmodulename:Here is some information
+   DEBUG:matplotlib.yourmodulename:Here is some more detailed information
 
 Which logging level to use?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -489,12 +491,10 @@ Matplotlib. For example, for the module::
         if bottom == top:
             warnings.warn('Attempting to set identical bottom==top')
 
-
 running the script::
 
     from matplotlib import my_matplotlib_module
-    my_matplotlib_module.set_range(0, 0)  #set range
-
+    my_matplotlib_module.set_range(0, 0)  # set range
 
 will display::
 
@@ -509,10 +509,12 @@ Modifying the module to use `._api.warn_external`::
         if bottom == top:
             _api.warn_external('Attempting to set identical bottom==top')
 
-and running the same script will display::
+and running the same script will display
+
+.. code-block:: none
 
-  UserWarning: Attempting to set identical bottom==top
-  my_matplotlib_module.set_range(0, 0)  #set range
+   UserWarning: Attempting to set identical bottom==top
+   my_matplotlib_module.set_range(0, 0)  # set range
 
 .. _logging tutorial: https://docs.python.org/3/howto/logging.html#logging-basic-tutorial
 
