[Docs] Add warning about stubtest code execution
#13927
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
docs/source/stubtest.rst
Outdated
Comment on lines
46
to
47
| stubtest attempts to import specified python modules. | ||
| It will execute all module level code. Please, keep this in mind. |
There was a problem hiding this comment.
Suggested change
| stubtest attempts to import specified python modules. | |
| It will execute all module level code. Please, keep this in mind. | |
| stubtest attempts to import specified Python modules. | |
| It will execute all module level code. |
"keep this in mind" doesn't really add anything
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
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.
Some of my students asked about this. I think it is better to have this information in the docs: it is important.