improve docstring of 'evalfile' and add doctest #47130
Merged
Conversation
This file contains 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
|
@kshyatt As mentioned earlier, here's the PR for an open issue regarding the documentation. To have a self-contained example (that also functions as a doctest), I ended up using |
fredrikekre
reviewed
Oct 19, 2022
fredrikekre
reviewed
Oct 20, 2022
|
Thank you for the support and suggestions @fredrikekre ! |
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.
This PR addresses the incomplete documentation of the
evalfilemethod mentioned in #45559.It explains the usage in more detail and adds a doctest example that users can copy&paste into a REPL session to experiment.