summaryrefslogtreecommitdiffstats
path: root/Doc/library/mmap.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-06-08 09:13:45 (GMT)
committerGeorg Brandl <georg@python.org>2009-06-08 09:13:45 (GMT)
commitcd7f32b6cd0dc03383319846e4c7962b4716e439 (patch)
treeb455b6962e36ced3a77b5f7ab8e647df57c3b790 /Doc/library/mmap.rst
parentcdf8b34b5164fb660c6d2554efb0bf45896c09e2 (diff)
downloadcpython-cd7f32b6cd0dc03383319846e4c7962b4716e439.zip
cpython-cd7f32b6cd0dc03383319846e4c7962b4716e439.tar.gz
cpython-cd7f32b6cd0dc03383319846e4c7962b4716e439.tar.bz2
Signature documentation style update, modules J, K, L and M.
Diffstat (limited to 'Doc/library/mmap.rst')
-rw-r--r--Doc/library/mmap.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst
index c3dba43..403e2f5 100644
--- a/Doc/library/mmap.rst
+++ b/Doc/library/mmap.rst
@@ -1,4 +1,3 @@
-
:mod:`mmap` --- Memory-mapped file support
==========================================
@@ -37,7 +36,7 @@ memory but does not update the underlying file.
To map anonymous memory, -1 should be passed as the fileno along with the length.
-.. class:: mmap(fileno, length[, tagname[, access[, offset]]])
+.. class:: mmap(fileno, length, tagname=None, access=ACCESS_DEFAULT[, offset])
**(Windows version)** Maps *length* bytes from the file specified by the
file handle *fileno*, and creates a mmap object. If *length* is larger
@@ -59,7 +58,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
defaults to 0. *offset* must be a multiple of the ALLOCATIONGRANULARITY.
-.. class:: mmap(fileno, length[, flags[, prot[, access[, offset]]]])
+.. class:: mmap(fileno, length, flags=MAP_SHARED, prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset])
:noindex:
**(Unix version)** Maps *length* bytes from the file specified by the file
@@ -148,7 +147,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
Returns ``-1`` on failure.
- .. method:: flush([offset, size])
+ .. method:: flush([offset[, size]])
Flushes changes made to the in-memory copy of a file back to disk. Without
use of this call there is no guarantee that changes are written back before