Skip to content

Commit b3983fc

Browse files
authored
fix contrib guide (#10895)
* fix contrib guide * proper formatting * fix indent
1 parent aafa189 commit b3983fc

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

doc/install/contributing.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -886,12 +886,16 @@ all the documentation and additionally execute just your example or tutorial
886886
you expect).
887887

888888
.. note::
889-
On Windows, to use the pattern approach, use the following two lines:
889+
If you are using a *Windows command shell*, to use the pattern approach,
890+
use the following two lines:
890891

891-
.. code-block:: python
892+
.. code-block:: doscon
892893
893-
set PATTERN={<REGEX_TO_SELECT_MY_TUTORIAL>}
894-
make html_dev-pattern
894+
> set PATTERN=<REGEX_TO_SELECT_MY_TUTORIAL>
895+
> make html_dev-pattern
896+
897+
If you are on Windows but using the `git BASH`_ shell, use the same two
898+
commands but replace ``set`` with ``export``.
895899

896900
After either of these commands completes, ``make show`` will open the
897901
locally-rendered documentation site in your browser. Additional ``make``
@@ -1017,7 +1021,6 @@ it can serve as a useful example of what to expect from the PR review process.
10171021
.. git installation
10181022
10191023
.. _the .dmg installer: https://git-scm.com/download/mac
1020-
.. _git for Windows: https://gitforwindows.org/
10211024
.. _official Linux instructions: https://git-scm.com/download/linux
10221025
.. _more detailed instructions and alternatives: https://www.atlassian.com/git/tutorials/install-git
10231026
.. _Windows subsystem for Linux: https://docs.microsoft.com/en-us/windows/wsl/about
@@ -1027,8 +1030,6 @@ it can serve as a useful example of what to expect from the PR review process.
10271030

10281031
.. github help pages
10291032
1030-
.. _GitHub Help: https://help.github.com
1031-
.. _GitHub learning lab: https://lab.github.com/
10321033
.. _fork: https://help.github.com/en/articles/fork-a-repo
10331034
.. _clone: https://help.github.com/en/articles/cloning-a-repository
10341035
.. _push: https://help.github.com/en/articles/pushing-to-a-remote

doc/links.inc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,10 @@
132132
.. _git: https://git-scm.com/
133133
.. _github: https://github.com
134134
.. _GitHub Help: https://help.github.com
135+
.. _GitHub learning lab: https://lab.github.com/
135136
.. _pro git book: https://git-scm.com/book/
137+
.. _git bash: https://gitforwindows.org/
138+
.. _git for Windows: https://gitforwindows.org/
136139
.. _git clone: http://schacon.github.com/git/git-clone.html
137140
.. _git checkout: https://schacon.github.io/git/git-checkout.html
138141
.. _git commit: https://schacon.github.io/git/git-commit.html

0 commit comments

Comments
 (0)