diff options
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/describing-code.rst | 9 |
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 |