Skip to content

Commit

Permalink
Merge pull request #47 from hMatoba/dev
Browse files Browse the repository at this point in the history
Update documents[ci skip]
  • Loading branch information
hMatoba committed Jan 7, 2018
2 parents 8677a39 + 9a63114 commit bd60eff
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ How to Use
There are only just five functions.

- *load(filename)* - Get exif data as *dict*.
- *dump(exif_dict)* - Get exif as *bytes* to save with JPEG.
- *insert(exif_bytes, filename)* - Insert exif into JPEG.
- *remove(filename)* - Remove exif from JPEG.
- *dump(exif_dict)* - Get exif as *bytes*.
- *insert(exif_bytes, filename)* - Insert exif into JPEG, or WebP.
- *remove(filename)* - Remove exif from JPEG, or WebP.
- *transplant(filename, filename)* - Transplant exif from JPEG to JPEG.

Example
Expand Down
20 changes: 10 additions & 10 deletions doc/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ load
Return exif data as dict. Keys(IFD name), be contained, are "0th", "Exif", "GPS", "Interop", "1st", and "thumbnail". Without "thumbnail", the value is dict(tag/value). "thumbnail" value is JPEG as bytes.

:param str filename: JPEG or TIFF
:param str filename: JPEG, WebP, or TIFF
:return: Exif data({"0th":dict, "Exif":dict, "GPS":dict, "Interop":dict, "1st":dict, "thumbnail":bytes})
:rtype: dict

Expand All @@ -36,7 +36,7 @@ load
Return exif data as dict. The keys(IFD name), will be contained, are "0th", "Exif", "GPS", "Interop", "1st", and "thumbnail". If there is no data to return, the key won't be contained. Without "thumbnail", the value is dict(tag name/tag value). "thumbnail" value is JPEG as bytes.

:param bytes data: JPEG, TIFF, or Exif
:param bytes data: JPEG, WebP, TIFF, or Exif
:return: Exif data({"0th":dict, "Exif":dict, "GPS":dict, "Interop":dict, "1st":dict, "thumbnail":bytes})
:rtype: dict

Expand Down Expand Up @@ -99,10 +99,10 @@ insert
------
.. py:function:: piexif.insert(exif_bytes, filename)
Insert exif into JPEG.
Insert exif into JPEG, or WebP.

:param bytes exif_bytes: Exif as bytes
:param str filename: JPEG
:param str filename: JPEG, or WebP

::

Expand All @@ -111,29 +111,29 @@ insert

.. py:function:: piexif.insert(exif_bytes, data, output)
Insert exif into JPEG.
Insert exif into JPEG, or WebP.

:param bytes exif_bytes: Exif as bytes
:param bytes data: JPEG data
:param bytes data: JPEG, or WebP data
:param io.BytesIO output: ouput data

remove
------
.. py:function:: piexif.remove(filename)
Remove exif from JPEG.
Remove exif from JPEG, or WebP.

:param str filename: JPEG
:param str filename: JPEG, or WebP

::

piexif.remove("foo.jpg")

.. py:function:: piexif.remove(data, output)
Remove exif from JPEG.
Remove exif from JPEG or WebP.

:param bytes data: JPEG data
:param bytes data: JPEG or WebP data
:param io.BytesIO output: output data

transplant
Expand Down

0 comments on commit bd60eff

Please sign in to comment.