summaryrefslogtreecommitdiff
path: root/sphinx/util/png.py
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-08-22 11:36:08 +0200
committerGeorg Brandl <georg@python.org>2010-08-22 11:36:08 +0200
commit5978c17aed477cc2bbab7eae86bb8b18367c426e (patch)
tree8a31a3695744a106791724453db559985f874c8e /sphinx/util/png.py
parentf160503120e0f72ea8b70bb850c92b8023bb9f6e (diff)
downloadsphinx-5978c17aed477cc2bbab7eae86bb8b18367c426e.tar.gz
Docstring harmonization.
Diffstat (limited to 'sphinx/util/png.py')
-rw-r--r--sphinx/util/png.py8
1 files changed, 3 insertions, 5 deletions
diff --git a/sphinx/util/png.py b/sphinx/util/png.py
index 2cb2aa9d..ca2273c4 100644
--- a/sphinx/util/png.py
+++ b/sphinx/util/png.py
@@ -21,9 +21,7 @@ IEND_CHUNK = '\x00\x00\x00\x00IEND\xAE\x42\x60\x82'
def read_png_depth(filename):
- """
- Read the special tEXt chunk indicating the depth from a PNG file.
- """
+ """Read the special tEXt chunk indicating the depth from a PNG file."""
result = None
f = open(filename, 'rb')
try:
@@ -39,8 +37,8 @@ def read_png_depth(filename):
def write_png_depth(filename, depth):
- """
- Write the special tEXt chunk indicating the depth to a PNG file.
+ """Write the special tEXt chunk indicating the depth to a PNG file.
+
The chunk is placed immediately before the special IEND chunk.
"""
data = struct.pack('!i', depth)