Clarified algorithm for stripping indentation from docstrings.

git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@982 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

1 files changed, 6 insertions, 5 deletions

diff --git a/docutils/docs/peps/pep-0257.txt b/docutils/docs/peps/pep-0257.txt
index 9ce589f88..7cc26480e 100644
--- a/docutils/docs/peps/pep-0257.txt
+++ b/docutils/docs/peps/pep-0257.txt
@@ -139,11 +139,12 @@ the rest of the docstring by a blank line.  The summary line may be on
 the same line as the opening quotes or on the next line.
 
 The entire docstring is indented the same as the quotes at its first
-line (see example below).  Docstring processing tools will strip an
-amount of indentation from the second and further lines of the
-docstring equal to the indentation of the first non-blank line after
-the first line of the docstring.  Relative indentation of later lines
-in the docstring is retained.
+line (see example below).  Docstring processing tools will strip a
+uniform amount of indentation from the second and further lines of the
+docstring, equal to the minimum indentation of all non-blank lines
+after the first line of the docstring.  Relative indentation of later
+lines in the docstring is retained.  Any indentation on the first line
+of the docstring (i.e., before the first newline) is removed.
 
 Insert a blank line before and after all docstrings (one-line or
 multi-line) that document a class -- generally speaking, the class's