-
Notifications
You must be signed in to change notification settings - Fork 441
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
Use imageio intersphinx links #2489
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2489 +/- ##
=======================================
Coverage 93.70% 93.70%
=======================================
Files 75 75
Lines 16072 16072
=======================================
Hits 15061 15061
Misses 1011 1011 |
Is this the documentation for https://imageio.readthedocs.io/en/stable/reference/userapi.html#imageio.v2.get_writer I'm not too familiar with how it chooses which writer, but assuming it is ffmpeg, the documented kwargs are here https://imageio.readthedocs.io/en/stable/_autosummary/imageio.plugins.ffmpeg.html |
Thanks @MatthewFlamm, I forgot that I found that on the page eventually... I could now fix our links by using
I don't know it either. And we also have |
I won't have bandwidth to figure out something better for this in the near future, so we should consider these changes for merging. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm okay with the changes. I agree that it would be great to figure out how to point users to the exact kwargs to use, but it doesn't seem straightforward.
* upstream/main: Make VTK version error clear when PointSet is still abstract (pyvista#2483) Use imageio intersphinx links (pyvista#2489) Fix glyphs when orienting with cell data (pyvista#2500) Bump mypy from 0.942 to 0.950 (pyvista#2522) Update hypothesis requirement from <6.45.1 to <6.45.2 (pyvista#2523) Add many Readers (pyvista#2496) Bump trimesh from 3.10.8 to 3.11.2 (pyvista#2519) Return actor from add_mesh_threshold (pyvista#2516) fix uniformgrid.x docstring (pyvista#2511) Update imageio requirement from <2.18.0 to <2.19.0 (pyvista#2506) Update hypothesis requirement from <6.44.1 to <6.45.1 (pyvista#2507) add polyhedral example (pyvista#2505)
We have the
imageio
intersphinx inventory located indoc/conf.py
, but we weren't actually using it. This is a quick fix for this.However, there's a related can of worms here: the links are kind of stale now, because
get_writer
is no longer documented onlineAny recommendation of what we should do on our side? Upgrade our pointers to v3? Can we use a better link for explaining gif/mp4 writer kwargs?