Edited docstring. [ci skip]

CHANGES.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+0.7.1
+------------------
+
+- Edited docstring.
+
 0.7.0c
 ------
 

doc/_build/html/_sources/index.txt

@@ -6,15 +6,15 @@
 Welcome to Piexif's documentation!
 ==================================
 
-To simplify exif manipulations with python. Writing, reading, and more... Piexif isn't a wrapper. To everywhere with Python.
-
 .. image:: https://travis-ci.org/hMatoba/Piexif.svg?branch=master
    :target: https://travis-ci.org/hMatoba/Piexif
 .. image:: https://coveralls.io/repos/hMatoba/Piexif/badge.svg?branch=master
    :target: https://coveralls.io/r/hMatoba/Piexif?branch=master
 .. image:: https://readthedocs.org/projects/piexif/badge/?version=latest
    :target: https://readthedocs.org/projects/piexif/
 
+To simplify exif manipulations with python. Writing, reading, and more... Piexif isn't a wrapper. To everywhere with Python.
+
 .. toctree::
    :maxdepth: 2
 

doc/_build/html/index.html

@@ -125,10 +125,10 @@
 
   <div class="section" id="welcome-to-piexif-s-documentation">
 <h1>Welcome to Piexif&#8217;s documentation!<a class="headerlink" href="#welcome-to-piexif-s-documentation" title="Permalink to this headline">¶</a></h1>
-<p>To simplify exif manipulations with python. Writing, reading, and more... Piexif isn&#8217;t a wrapper. To everywhere with Python.</p>
 <a class="reference external image-reference" href="https://travis-ci.org/hMatoba/Piexif"><img alt="https://travis-ci.org/hMatoba/Piexif.svg?branch=master" src="https://travis-ci.org/hMatoba/Piexif.svg?branch=master" /></a>
 <a class="reference external image-reference" href="https://coveralls.io/r/hMatoba/Piexif?branch=master"><img alt="https://coveralls.io/repos/hMatoba/Piexif/badge.svg?branch=master" src="https://coveralls.io/repos/hMatoba/Piexif/badge.svg?branch=master" /></a>
 <a class="reference external image-reference" href="https://readthedocs.org/projects/piexif/"><img alt="https://readthedocs.org/projects/piexif/badge/?version=latest" src="https://readthedocs.org/projects/piexif/badge/?version=latest" /></a>
+<p>To simplify exif manipulations with python. Writing, reading, and more... Piexif isn&#8217;t a wrapper. To everywhere with Python.</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="about.html">About Piexif</a><ul>

doc/_build/html/objects.inv

@@ -2,6 +2,5 @@
 # Project: Piexif
 # Version: 0.7.0
 # The remainder of this file is compressed using zlib.
-xڍ�1
-�0�ݧ��Ys��BO�FJb�ec;%�})��Bo���A��a��J��!�Ӳ˜���4l���
-Z��qw�Gr�Mݜ��n����H��+��RƉ͋��-n߬��?4����{ܙ�(����;)]��f%�
�΄�
+xڍ�=
+�0��=���Ys��BO��Jb�ec�%�}b�B��O�+�㴂$3��!�@>[�&G����d��o^���w��A�C�G�go2a�����}D�����yJ�3PO��#���kӌS�,�4��IJ`l�&��?
�3��

doc/index.rst

@@ -6,15 +6,15 @@
 Welcome to Piexif's documentation!
 ==================================
 
-To simplify exif manipulations with python. Writing, reading, and more... Piexif isn't a wrapper. To everywhere with Python.
-
 .. image:: https://travis-ci.org/hMatoba/Piexif.svg?branch=master
    :target: https://travis-ci.org/hMatoba/Piexif
 .. image:: https://coveralls.io/repos/hMatoba/Piexif/badge.svg?branch=master
    :target: https://coveralls.io/r/hMatoba/Piexif?branch=master
 .. image:: https://readthedocs.org/projects/piexif/badge/?version=latest
    :target: https://readthedocs.org/projects/piexif/
 
+To simplify exif manipulations with python. Writing, reading, and more... Piexif isn't a wrapper. To everywhere with Python.
+
 .. toctree::
    :maxdepth: 2
 

piexif/__init__.py

@@ -4,4 +4,4 @@
 from ._insert import insert
 
 
-VERSION = '0.7.0c'
+VERSION = '0.7.1'

piexif/_insert.py

@@ -1,16 +1,17 @@
-"""
-"""
-
 import io
 import struct
 
 from ._common import *
 
 
 def insert(exif, image, new_file=""):
-    """Inserts exif bytes to JPEG file
-    insert(exif, image, new_file[optional])
-    When "new_file" is not given, "image" file is overwritten.
+    """
+    py:function:: piexif.insert(exif_bytes, filename)
+
+    Insert exif into JPEG.
+
+    :param bytes exif_bytes: Exif as bytes
+    :param str filename: JPEG
     """
     if exif[0:6] != b"\x45\x78\x69\x66\x00\x00":
         raise ValueError("Given data is not exif data")

piexif/_load_and_dump.py

@@ -1,38 +1,3 @@
-"""EXIF is a set of several IFDs.
-Oth IFD can include "Make", "Model" and more...
-Exif IFD can include "ExposureTime", "ISOSpeed" and more...
-GPS IFD can include GPS information.
-
-Pass dict(s), that shows several IFD, to "dump" function.
-exifbytes = pyxif.dump(0th_dict, exif_dict, gps_dict) # second and third are optional.
-
-To use dict as IFD data, it needs...
-  A tag number means which property? - 256: ImageWidth, 272: Model...
-  Appropriate type for property. - long for ImageWidth, str for Model...
-    zeroth_ifd = {pyxif.ZerothIFD.Make: "Canon",
-                  pyxif.ZerothIFD.XResolution: (96, 1),
-                  pyxif.ZerothIFD.YResolution: (96, 1),
-                  pyxif.ZerothIFD.Software: "Photoshop x.x.x",
-                  }
-
-Property name and tag number
-  For 0th IFD - under "pyxif.ZerothIFD"
-  For Exif IFD - under "pyxif.ExifIFD"
-  For GPS IFD - under "pyxif.GPSIFD"
-
-Property and appropriate type
-  See variable"TAGS" in this script.
-
-"Byte": int
-"Ascii": str
-"Short": int
-"Long": Long
-"Rational": (long, long)
-"Undefined": str
-"SLong": long
-"SRational": (long, long)
-"""
-
 import copy
 import io
 import struct
@@ -240,9 +205,14 @@ def get_info(self, val):
 
 
 def load(input_data):
-    r"""converts exif bytes to dicts
-    zeroth_dict, exif_dict, gps_dict = pyxif.load(input_data)
-    input_data - filename or JPEG data(b"\xff\xd8......")
+    r"""
+    py:function:: piexif.load(filename)
+
+    Return three IFD data that are 0thIFD, ExifIFD, and GPSIFD as dict.
+
+    :param str filename: JPEG or TIFF
+    :return: 0th IFD, Exif IFD, and GPS IFD
+    :rtype: dict, dict, dict
     """
     exifReader = ExifReader(input_data)
     if exifReader.exif_str is None:
@@ -259,11 +229,14 @@ def load(input_data):
 
 
 def dump(zeroth_ifd_original, exif_ifd={}, gps_ifd={}):
-    """converts dict to exif bytes
-    exif_bytes = pyxif.dump(zeroth_ifd, exif_ifd[optional], gps_ifd[optional])
-    zeroth_ifd - dict of 0th IFD
-    exif_ifd - dict of Exif IFD
-    gps_ifd - dict of GPS IFD
+    """
+    py:function:: piexif.load(data)
+
+    Return three IFD data that are 0thIFD, ExifIFD, and GPSIFD as dict.
+
+    :param bytes data: JPEG or TIFF
+    :return: 0th IFD, Exif IFD, and GPS IFD
+    :rtype: dict, dict, dict
     """
     zeroth_ifd = copy.deepcopy(zeroth_ifd_original)
     header = b"\x45\x78\x69\x66\x00\x00\x4d\x4d\x00\x2a\x00\x00\x00\x08"

piexif/_remove.py

@@ -1,18 +1,15 @@
-"""PIL's image resize manipulation(includes thumbnail function) loses JPEG's.
-Helps to transplant Exif data into another JPEG.
-Tested on Python 2.7 and 3.4
-"""
-
 import io
 
 from ._common import *
 
 
 def remove(src, new_file=""):
-    """Removes exif.
-    remove(src, new_file[optional])
-    src - filename or JPEG data(2.7 - str, 3.4 - bytes)
-    When "new_file" is not given, "src" is overwritten.
+    """
+    py:function:: piexif.remove(filename)
+
+    Remove exif from JPEG.
+
+    :param str filename: JPEG
     """
     output_is_file = False
     if src[0:2] == b"\xff\xd8":

piexif/_transplant.py

@@ -1,17 +1,16 @@
-"""PIL's image resize manipulation(includes thumbnail function) loses JPEG's.
-Helps to transplant Exif data into another JPEG.
-Tested on Python 2.7 and 3.4
-"""
-
 import io
 
 from ._common import *
 
 
 def transplant(exif_src, image, new_file=""):
-    """Transplants exif to another JPEG
-    transplant(exif_src, image, new_file[optional])
-    When "new_file" is not given, "image" file is overwritten.
+    """
+    py:function:: piexif.transplant(filename1, filename2)
+
+    Transplant exif from filename1 to filename2.
+
+    :param str filename1: JPEG
+    :param str filename2: JPEG
     """
     if exif_src[0:2] == b"\xff\xd8":
         src_data = exif_src