python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-12-25 17:36:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fixing doc warnings, reformatting docstring comments

Browse Source
This commit is contained in:
wiredfool 2014-07-14 21:24:54 -07:00
parent d80eef46ce
commit a0d6cf01ce
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
PIL/OleFileIO.py
View File

@ -15,8 +15,11 @@ Improved version of the OleFileIO module from PIL library v1.1.6
See: http://www.pythonware.com/products/pil/index.htm See: http://www.pythonware.com/products/pil/index.htm
The Python Imaging Library (PIL) is The Python Imaging Library (PIL) is
Copyright (c) 1997-2005 by Secret Labs AB Copyright (c) 1997-2005 by Secret Labs AB
Copyright (c) 1995-2005 by Fredrik Lundh Copyright (c) 1995-2005 by Fredrik Lundh
OleFileIO_PL changes are Copyright (c) 2005-2014 by Philippe Lagadec OleFileIO_PL changes are Copyright (c) 2005-2014 by Philippe Lagadec
See source code and LICENSE.txt for information on usage and redistribution. See source code and LICENSE.txt for information on usage and redistribution.
@ -1701,10 +1704,12 @@ class OleFileIO:
Open a stream as a read-only file object (BytesIO). Open a stream as a read-only file object (BytesIO).
filename: path of stream in storage tree (except root entry), either: filename: path of stream in storage tree (except root entry), either:
- a string using Unix path syntax, for example: - a string using Unix path syntax, for example:
'storage_1/storage_1.2/stream' 'storage_1/storage_1.2/stream'
- a list of storage filenames, path to the desired stream/storage. - a list of storage filenames, path to the desired stream/storage.
Example: ['storage_1', 'storage_1.2', 'stream'] Example: ['storage_1', 'storage_1.2', 'stream']
return: file object (read-only) return: file object (read-only)
raise IOError if filename not found, or if this is not a stream. raise IOError if filename not found, or if this is not a stream.
""" """
@ -1722,6 +1727,7 @@ class OleFileIO:
filename: path of stream in storage tree. (see openstream for syntax) filename: path of stream in storage tree. (see openstream for syntax)
return: False if object does not exist, its entry type (>0) otherwise: return: False if object does not exist, its entry type (>0) otherwise:
- STGTY_STREAM: a stream - STGTY_STREAM: a stream
- STGTY_STORAGE: a storage - STGTY_STORAGE: a storage
- STGTY_ROOT: the root entry - STGTY_ROOT: the root entry
@ -1812,7 +1818,7 @@ class OleFileIO:
filename: path of stream in storage tree (see openstream for syntax) filename: path of stream in storage tree (see openstream for syntax)
convert_time: bool, if True timestamps will be converted to Python datetime convert_time: bool, if True timestamps will be converted to Python datetime
no_conversion: None or list of int, timestamps not to be converted no_conversion: None or list of int, timestamps not to be converted
(for example total editing time is not a real timestamp) (for example total editing time is not a real timestamp)
return: a dictionary of values indexed by id (integer) return: a dictionary of values indexed by id (integer)
""" """
# make sure no_conversion is a list, just to simplify code below: # make sure no_conversion is a list, just to simplify code below: