python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-02-09 16:10:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

Move useful comment into docstring

Browse Source
This commit is contained in:
Hugo van Kemenade 2022-04-10 20:22:47 +03:00
parent 855c1a12da
commit 1997c814ab
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/PIL/GifImagePlugin.py
View File

@ -990,8 +990,6 @@ def getheader(im, palette=None, info=None):
return header, used_palette_colors return header, used_palette_colors
# To specify duration, add the time in milliseconds to getdata(),
# e.g. getdata(im_frame, duration=1000)
def getdata(im, offset=(0, 0), **params): def getdata(im, offset=(0, 0), **params):
""" """
Legacy Method Legacy Method
@ -1000,10 +998,13 @@ def getdata(im, offset=(0, 0), **params):
The first string is a local image header, the rest contains The first string is a local image header, the rest contains
encoded image data. encoded image data.
To specify duration, add the time in milliseconds,
e.g. ``getdata(im_frame, duration=1000)``
:param im: Image object :param im: Image object
:param offset: Tuple of (x, y) pixels. Defaults to (0,0) :param offset: Tuple of (x, y) pixels. Defaults to (0, 0)
:param \\**params: E.g. duration or other encoder info parameters :param \\**params: e.g. duration or other encoder info parameters
:returns: List of Bytes containing gif encoded frame data :returns: List of bytes containing GIF encoded frame data
""" """