From: Sean Reifscheider <jafo@tummy.com>
Date: Tue, 18 Sep 2007 23:34:44 +0000 (+0000)
Subject: issue1172: Documentation of "done" attribute in cgi module.
X-Git-Tag: v2.6a1~1270
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=111c0ea34a3308a99589704f6f156185d192b5f4;p=python

issue1172: Documentation of "done" attribute in cgi module.
---

diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst
index 29ed5459e3..6b2e3d257b 100644
--- a/Doc/library/cgi.rst
+++ b/Doc/library/cgi.rst
@@ -147,6 +147,11 @@ attribute::
            if not line: break
            linecount = linecount + 1
 
+If an error is encountered when obtaining the contents of an uploaded file
+(for example, when the user interrupts the form submission by clicking on
+a Back or Cancel button) the :attr:`done` attribute of the object for the
+field will be set to the value -1.
+
 The file upload draft standard entertains the possibility of uploading multiple
 files from one field (using a recursive :mimetype:`multipart/\*` encoding).
 When this occurs, the item will be a dictionary-like :class:`FieldStorage` item.