summaryrefslogtreecommitdiff
path: root/docutils/docs/ref
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-01-04 17:03:32 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-01-04 17:03:32 +0000
commit15e8837003b411646a667ff1c52ca5c4c1701719 (patch)
treeacef3ceeb31751a8c16ede697c133ab189e31965 /docutils/docs/ref
parent6562f2207c1fd5b7533f1982560450549ffb9341 (diff)
downloaddocutils-15e8837003b411646a667ff1c52ca5c4c1701719.tar.gz
Documentation update.
* Small clarification in the rST spec. * Move detailled description of alternative ways to install for development from the "Docutils policies" to the "repository" documentation. We don't need to go into details in the "policies" document and "edible installs" are also useful for casual contributors or power-users. * Update links and optional dependencies in the README, use terminology from PEP 621. Move the sandbox snapshot download doc to the sandbox README. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8929 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/ref')
-rw-r--r--docutils/docs/ref/rst/restructuredtext.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/docutils/docs/ref/rst/restructuredtext.txt b/docutils/docs/ref/rst/restructuredtext.txt
index 276f4f0ec..83aa3894b 100644
--- a/docutils/docs/ref/rst/restructuredtext.txt
+++ b/docutils/docs/ref/rst/restructuredtext.txt
@@ -2762,9 +2762,10 @@ backquotes in an end-string context (according to the recognition
rules above). No markup interpretation (including backslash-escape
interpretation) is done within inline literals.
-Line breaks are *not* preserved in inline literals. Although a
-reStructuredText parser will preserve runs of spaces in its output,
-the final representation of the processed document is dependent on the
+Line breaks and sequences of whitespace characters
+are *not* protected in inline literals.
+Although a reStructuredText parser will preserve them in its output,
+the final representation of the processed document depends on the
output formatter, thus the preservation of whitespace cannot be
guaranteed. If the preservation of line breaks and/or other
whitespace is important, `literal blocks`_ should be used.