Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add additional kwargs to open_gif #2484

Merged
merged 3 commits into from
Apr 19, 2022
Merged

add additional kwargs to open_gif #2484

merged 3 commits into from
Apr 19, 2022

Conversation

akaszynski
Copy link
Member

@akaszynski akaszynski commented Apr 18, 2022

Resolve #2468 by adding additional keyword arguments to open_gif and improving the docstring.

Bonus (there always is)

Added a unit test for open_gif, because apparently it's part of the 6.33 we're not covering in our tests.

@tkoyama010 tkoyama010 added the enhancement Changes that enhance the library label Apr 18, 2022
@codecov
Copy link

codecov bot commented Apr 18, 2022

Codecov Report

Merging #2484 (8777dbb) into main (18c2992) will increase coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #2484      +/-   ##
==========================================
+ Coverage   93.67%   93.70%   +0.03%     
==========================================
  Files          75       75              
  Lines       16052    16052              
==========================================
+ Hits        15036    15041       +5     
+ Misses       1016     1011       -5     

@akaszynski akaszynski merged commit 7382959 into main Apr 19, 2022
@akaszynski akaszynski deleted the feat/gif_kwargs branch April 19, 2022 03:17
Comment on lines +3397 to +3399
fps : float, optional
The number of frames per second. If duration is not given, the
duration for each frame is set to 1/fps. Default 10.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's mention of "if duration is not given", but duration is not an explicit kwarg. Perhaps it should be? Or we should make it explicit that this can be passed on to get_writer? And can we give a better pointer for kwarg documentation than imageio.get_writer()? (See also my comment for #2489)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Changes that enhance the library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Plotter.open_gif() increase the parameter that support framerate
3 participants