summaryrefslogtreecommitdiffstats
path: root/Doc/library/chunk.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-04-05 22:20:44 (GMT)
committerGeorg Brandl <georg@python.org>2009-04-05 22:20:44 (GMT)
commit0d8f07305d7ddcf684c3db5680263c98cf70c067 (patch)
tree8862b638d9b3e98ce030044765e9231333821f94 /Doc/library/chunk.rst
parent889b0aa4506d5ea43985865a44562ebd39b3bf00 (diff)
downloadcpython-0d8f07305d7ddcf684c3db5680263c98cf70c067.zip
cpython-0d8f07305d7ddcf684c3db5680263c98cf70c067.tar.gz
cpython-0d8f07305d7ddcf684c3db5680263c98cf70c067.tar.bz2
Update signature style of optional arguments, part two.
Diffstat (limited to 'Doc/library/chunk.rst')
-rw-r--r--Doc/library/chunk.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/Doc/library/chunk.rst b/Doc/library/chunk.rst
index 64ce4e2..d3558a4 100644
--- a/Doc/library/chunk.rst
+++ b/Doc/library/chunk.rst
@@ -1,4 +1,3 @@
-
:mod:`chunk` --- Read IFF chunked data
======================================
@@ -51,7 +50,7 @@ new instance can be instantiated. At the end of the file, creating a new
instance will fail with a :exc:`EOFError` exception.
-.. class:: Chunk(file[, align, bigendian, inclheader])
+.. class:: Chunk(file, align=True, bigendian=True, inclheader=False)
Class which represents a chunk. The *file* argument is expected to be a
file-like object. An instance of this class is specifically allowed. The
@@ -94,7 +93,7 @@ instance will fail with a :exc:`EOFError` exception.
Returns ``False``.
- .. method:: seek(pos[, whence])
+ .. method:: seek(pos, whence=0)
Set the chunk's current position. The *whence* argument is optional and
defaults to ``0`` (absolute file positioning); other values are ``1``
@@ -108,7 +107,7 @@ instance will fail with a :exc:`EOFError` exception.
Return the current position into the chunk.
- .. method:: read([size])
+ .. method:: read(size=-1)
Read at most *size* bytes from the chunk (less if the read hits the end of
the chunk before obtaining *size* bytes). If the *size* argument is