summaryrefslogtreecommitdiff
path: root/doc/markup/code.rst
diff options
context:
space:
mode:
authorjfbu <jfbu@free.fr>2017-02-10 14:35:58 +0100
committerjfbu <jfbu@free.fr>2017-02-10 14:35:58 +0100
commit839e924808ad5c8cad8bed567e86eb7cd6970d7c (patch)
tree40342da2cd0fa61578b9618ef0cdbdcc408110fa /doc/markup/code.rst
parentd4bd7cba5f9b635e7c6a32f7df5f6606dc6fb174 (diff)
downloadsphinx-git-839e924808ad5c8cad8bed567e86eb7cd6970d7c.tar.gz
Improve docs about ``:lines:̀`` vs ̀``:start-after:`` (refs #3412)
Diffstat (limited to 'doc/markup/code.rst')
-rw-r--r--doc/markup/code.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/markup/code.rst b/doc/markup/code.rst
index c7cb0f911..ff0f692fa 100644
--- a/doc/markup/code.rst
+++ b/doc/markup/code.rst
@@ -182,7 +182,9 @@ Includes
``start-after`` is given as a string option, only lines that follow the first
line containing that string are included. If ``end-before`` is given as a
string option, only lines that precede the first lines containing that string
- are included.
+ are included. If used in combination with ``lines``, make sure the latter
+ allows the lines (whose count start at ``1`` at top of file) containing the
+ looked-for strings.
When specifying particular parts of a file to display, it can be useful to
display exactly which lines are being presented.