docs: Add doctest examples to micropip.install function - #244
Merged
Conversation
ryanking13
reviewed
Aug 14, 2025
ryanking13
left a comment
ryanking13
left a comment
Member
There was a problem hiding this comment.
Thanks @grden!
I assumed the tests for micropip will run within the already-established Pyodide environment. Happy to update if this assumption is incorrect.
No, it does not. But I think it is better not to run doctest in this case, as we don't want to make network calls to PyPI in unittests.
Example-wise looks good to me. I added one minor comment.
| >>> await micropip.install("numpy>=2.2.0") | ||
|
|
||
| For more details and advanced usage, see the user manual: | ||
| https://pyodide.org/en/stable/usage/loading-packages.html#micropip |
Member
There was a problem hiding this comment.
Doctest itself is a document, and it will be shown in the micropip docs, so I think this comment is redundant.
Contributor
Author
|
Removed redundant docstring. Thank you! |
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
2 participants
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.
Added docstring examples for
micropip.install().I haven’t included any flags (i.e.
# doctest: +RUN_IN_PYODIDEor# doctest: +SKIP) as I assumed the tests for micropip will run within the already-established Pyodide environment. Happy to update if this assumption is incorrect.This partially addresses issue pyodide/pyodide#1955