summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorJulien Palard <julien@palard.fr>2022-06-16 20:32:09 +0200
committerGitHub <noreply@github.com>2022-06-16 19:32:09 +0100
commit956cddb7d406a81edf26d80ff408f76aa01d0f24 (patch)
tree364db66bc08798a05c5c134768c97fa4b20c4574 /doc/tutorial
parent2a88d8074bad2b7469ad47e78211bc3904192a96 (diff)
downloadsphinx-git-956cddb7d406a81edf26d80ff408f76aa01d0f24.tar.gz
Replace doclinter with sphinx-lint (#10389)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/describing-code.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst
index 57f1b2008..24fea38a6 100644
--- a/doc/tutorial/describing-code.rst
+++ b/doc/tutorial/describing-code.rst
@@ -85,10 +85,11 @@ you can use :rst:role:`py:func` for that, as follows:
or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
will raise an exception.
-When generating code documentation, Sphinx will generate a cross-reference automatically just
-by using the name of the object, without you having to explicitly use a role
-for that. For example, you can describe the custom exception raised by the
-function using the :rst:dir:`py:exception` directive:
+When generating code documentation, Sphinx will generate a
+cross-reference automatically just by using the name of the object,
+without you having to explicitly use a role for that. For example, you
+can describe the custom exception raised by the function using the
+:rst:dir:`py:exception` directive:
.. code-block:: rst
:caption: docs/source/usage.rst