Updated docs

This commit is contained in:
Rhet Turnbull
2020-03-14 20:54:53 -07:00
parent 940fc33f11
commit c11afbaa6e
2 changed files with 7 additions and 1 deletions

View File

@@ -506,6 +506,12 @@ class PhotoInfo:
""" export photo
dest: must be valid destination path (or exception raised)
filename: (optional): name of picture; if not provided, will use current filename
**NOTE**: if provided, user must ensure file extension (suffix) is correct.
For example, if photo is .CR2 file, edited image may be .jpeg.
If you provide an extension different than what the actual file is,
export will print a warning but will happily export the photo using the
incorrect file extension. e.g. to get the extension of the edited photo,
reference PhotoInfo.path_edited
edited: (boolean, default=False); if True will export the edited version of the photo
(or raise exception if no edited version)
live_photo: (boolean, default=False); if True, will also export the associted .mov for live photos