Skip to content

Commit 75e0422

Browse files
Fix incorrect reST indents in docs (#351)
* Fix bad indents in debugging.rst, submit-a-report.rst & scientific-computing.rst * Update Sphinx-Lint to v0.8.1 in pre-commit config --------- Co-authored-by: C.A.M. Gerlach <[email protected]>
1 parent 7a079ea commit 75e0422

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ repos:
168168

169169
# Lint RST
170170
- repo: https://github.com/sphinx-contrib/sphinx-lint
171-
rev: 'v0.6.1'
171+
rev: v0.8.1
172172
hooks:
173173
- id: sphinx-lint
174174
name: Lint RST

doc/panes/debugging.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ To open it, select :menuselection:`Debug --> List breakpoints`, or press :kbd:`C
6161

6262
There are several different ways to set and clear breakpoints:
6363

64-
* With the :guilabel:`Set/clear breakpoint` option in the Debug menu.
65-
* Through pressing the configurable keyboard shortcut (:kbd:`F12` for normal, or :kbd:`Shift-F12` for conditional breakpoints by default).
66-
* By clicking to the left of the line number in an open file in the Editor (adding :kbd:`Shift` for a conditional breakpoint).
67-
* With the ``breakpoint()`` builtin function in your code.
68-
* Interactively, using the ``b`` command in a debugging session.
64+
* With the :guilabel:`Set/clear breakpoint` option in the Debug menu.
65+
* Through pressing the configurable keyboard shortcut (:kbd:`F12` for normal, or :kbd:`Shift-F12` for conditional breakpoints by default).
66+
* By clicking to the left of the line number in an open file in the Editor (adding :kbd:`Shift` for a conditional breakpoint).
67+
* With the ``breakpoint()`` builtin function in your code.
68+
* Interactively, using the ``b`` command in a debugging session.
6969

7070
.. image:: /images/debugging/debugging-breakpoints.gif
7171
:alt: Spyder showing setting conditional breakpoint

doc/troubleshooting/submit-a-report.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,27 +60,27 @@ The key items, in order of priority:
6060

6161
* The full, **complete error message or traceback** copy/pasted or automatically entered exactly as displayed by Spyder:
6262

63-
- Auto-generated reports directly from the error dialog should include this automatically, but double check to make sure.
64-
- You can copy and paste this from the the :guilabel:`Show Details` section of the error dialog.
65-
- If not present, or a dialog is not displayed, you can also find it printed to Spyder's :guilabel:`Internal Console`, located under the :guilabel:`View` menu at :menuselection:`Panes --> Internal Console`.
66-
- If you prefer, or if Spyder won't start, you can start Spyder from your command line (or Anaconda prompt on windows) with ``spyder`` and copy the output printed there.
63+
- Auto-generated reports directly from the error dialog should include this automatically, but double check to make sure.
64+
- You can copy and paste this from the the :guilabel:`Show Details` section of the error dialog.
65+
- If not present, or a dialog is not displayed, you can also find it printed to Spyder's :guilabel:`Internal Console`, located under the :guilabel:`View` menu at :menuselection:`Panes --> Internal Console`.
66+
- If you prefer, or if Spyder won't start, you can start Spyder from your command line (or Anaconda prompt on windows) with ``spyder`` and copy the output printed there.
6767

68-
.. note::
68+
.. note::
6969

70-
If you are reporting a specific behavior rather than an error, or the message does not fully explain what occurs, please describe in detail what actually happened, and what you expected Spyder to do.
70+
If you are reporting a specific behavior rather than an error, or the message does not fully explain what occurs, please describe in detail what actually happened, and what you expected Spyder to do.
7171

7272
* A **detailed, step by step description of exactly what you did** leading up to the error occurring, complete with sample code that triggers it, if applicable.
7373

7474
* **Information about Spyder and its environment** as listed in the error report template, which you can find under :guilabel:`About Spyder` in the :guilabel:`Help` menu; along with its key dependencies, shown in the dialog under :menuselection:`Help --> Dependencies` (there's a button to copy-paste them).
7575

76-
.. image:: /images/submit-a-report/submit-a-report-spyder-info.png
77-
:alt: Spyder showing Spyder's info and dependencies
76+
.. image:: /images/submit-a-report/submit-a-report-spyder-info.png
77+
:alt: Spyder showing Spyder's info and dependencies
7878

79-
If Spyder won't launch, paste the output of ``conda list`` from your command line (or Anaconda prompt on Windows) in the :guilabel:`Dependencies` section of the issue template.
79+
If Spyder won't launch, paste the output of ``conda list`` from your command line (or Anaconda prompt on Windows) in the :guilabel:`Dependencies` section of the issue template.
8080

81-
.. image:: /images/submit-a-report/submit-a-report-conda-list.png
82-
:alt: Command line showing output of conda list
83-
:width: 500px
81+
.. image:: /images/submit-a-report/submit-a-report-conda-list.png
82+
:alt: Command line showing output of conda list
83+
:width: 500px
8484

8585
* **How you installed Spyder** and any other relevant packages, *e.g.* Anaconda, MacPorts or pip and **whether Spyder has worked before** since you installed it.
8686

doc/workshops/scientific-computing.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ You will need to have Spyder installed. Visit our :doc:`installation guide<../in
1919

2020
It is also desirable to have the following prior knowledge:
2121

22-
* Basic level of Python. You can visit `The Python Tutorial`_ to learn the basics of this programming language.
23-
* Some knowledge of Statistics (`hypothesis testing`_ , `ANOVA`_, `p-value`_)
22+
* Basic level of Python. You can visit `The Python Tutorial`_ to learn the basics of this programming language.
23+
* Some knowledge of Statistics (`hypothesis testing`_ , `ANOVA`_, `p-value`_)
2424

25-
.. _The Python Tutorial: https://docs.python.org/3/tutorial/
26-
.. _hypothesis testing: https://en.wikipedia.org/wiki/Statistical_hypothesis_testing
27-
.. _ANOVA: https://en.wikipedia.org/wiki/Analysis_of_variance
28-
.. _p-value: https://en.wikipedia.org/wiki/P-value
25+
.. _The Python Tutorial: https://docs.python.org/3/tutorial/
26+
.. _hypothesis testing: https://en.wikipedia.org/wiki/Statistical_hypothesis_testing
27+
.. _ANOVA: https://en.wikipedia.org/wiki/Analysis_of_variance
28+
.. _p-value: https://en.wikipedia.org/wiki/P-value
2929

3030

3131

0 commit comments

Comments
 (0)