-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Kaleido docs updates for v1 #5111
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
Conversation
...ly.py into kaleido-docs-updates
...ly.py into kaleido-docs-updates
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
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.
Add section here (or elsewhere in the file) documenting the new pio.write_images function, recommended for exporting multiple images in a row because it is much faster than calling pio.write_image repeatedly.
Documentation for the function is here. Happy to help suggest wording if that would be helpful.
pio.write_images should also be referenced in the Kaleido v1 migration doc, because anyone calling write_images many times in a row will notice a significant performance hit unless they switch to using pio.write_images.
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.
Added an example and note in the migration doc
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
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.
Should link to the Chrome setup instructions from this doc, since that's one of the major differences between Kaleido v0 and v1.
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.
Looks great @LiamConnors ! 🚀
The pio.write_images documentation should be added; all my other comments are just minor details.
Uh oh!
There was an error while loading. Please reload this page.
This PR adds changes for Kaleido v1