summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorJuan Luis Cano Rodríguez <hello@juanlu.space>2021-09-06 16:24:11 +0200
committerJuan Luis Cano Rodríguez <hello@juanlu.space>2021-09-06 16:26:03 +0200
commitda93cfc07ff675d62f9a83f2bf48acd674da5532 (patch)
treec058c9408a8340eb44b2cfa1e23701056144110b /doc/tutorial
parent722629b35b849123edac63a219774aadc8567aec (diff)
downloadsphinx-git-da93cfc07ff675d62f9a83f2bf48acd674da5532.tar.gz
Reword primary domains
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/describing-code.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst
index 305160ab0..a690e9d0a 100644
--- a/doc/tutorial/describing-code.rst
+++ b/doc/tutorial/describing-code.rst
@@ -55,9 +55,12 @@ Notice several things:
.. note::
- Since Python is the default :term:`domain`, you can write
- ``.. function::`` directly without having to prefix the directive with
- ``py:``.
+ The ``py:`` prefix specifies the :term:`domain`. You may configure the
+ default domain so you can omit the prefix, either globally using the
+ :confval:`primary_domain` configuration, or per-file using the
+ :rst:dir:`default-domain` directive.
+ For example, if you set it to ``py`` (the default), you can write
+ ``.. function::`` directly.
Cross-referencing Python objects
--------------------------------