From: Jeroen Ruigrok van der Werven <asmodai@in-nomine.org>
Date: Wed, 16 Apr 2008 12:57:43 +0000 (+0000)
Subject: Add details about the return value for mmap.flush().
X-Git-Tag: v2.6a3~176
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=967a83c4efdbd32f24763bc90afabcfe3d76f4b6;p=python

Add details about the return value for mmap.flush().
---

diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst
index ca0a2eb6ef..d2a6d1e4b4 100644
--- a/Doc/library/mmap.rst
+++ b/Doc/library/mmap.rst
@@ -162,6 +162,12 @@ Memory-mapped file objects support the following methods:
    changes to the given range of bytes will be flushed to disk; otherwise, the
    whole extent of the mapping is flushed.
 
+   **(Windows version)** A nonzero value returned indicates success; zero
+   indicates failure.
+
+   **(Unix version)** A zero value is returned to indicate success. An
+   exception is raised when the call failed.
+
 
 .. method:: mmap.move(dest, src, count)