fixing code examples in README#391
Open
tschm wants to merge 6 commits intoplotly:masterfrom
Open
Conversation
Contributor
Author
|
I test the README file in #390 |
Collaborator
|
It should be! Thanks for this, we're working on all this fulltime at the moment so you should see great progress on your PRs and documentation. I will confirm this through the course of the week. |
gvwilson
added
documentation
There was a problem hiding this comment.
Pull request overview
This PR corrects the Python README example so the top-level kaleido.write_fig(...) usage matches the actual public API. It improves the quickstart documentation for users of the Python package by removing an invalid argument from the async convenience-wrapper example.
Changes:
- Remove the unsupported
n=4argument from thekaleido.write_fig(...)example insrc/py/README.md. - Keep the example focused on the valid shortcut-function pattern for writing a figure without explicitly constructing
Kaleido.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I think "n" is not an argument for the write_fig function