[Python-3000-checkins] r58201 - python/branches/py3k/Doc/library/cgi.rst

[sean.reifschneider]

Author: sean.reifschneider
Date: Wed Sep 19 01:39:35 2007
New Revision: 58201

Modified:
   python/branches/py3k/Doc/library/cgi.rst
Log:
issue1172: Documentation of "done" attribute in cgi module.


Modified: python/branches/py3k/Doc/library/cgi.rst
==============================================================================
--- python/branches/py3k/Doc/library/cgi.rst	(original)
+++ python/branches/py3k/Doc/library/cgi.rst	Wed Sep 19 01:39:35 2007
@@ -147,6 +147,11 @@
            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.