gh-115177: Clarify impact of -O and optimization in assert statement documentation #119305
Conversation
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
… asserts in assert statement documentation * The current simple_stmts.html#the-assert-statement text mentions -O as a tiny hyperlink over to #cmdoption-O but doesn't mention the PYTHONOPTIMIZE environment variable. This commit adds a hyperlink to it.
…ssues with code containng assert statements when optimization is enabled Added a remainder that logic could break when optimization is enabled when using assert statements in code. Mentioned that it's considered best practice to not use assert statements to evaluate function variables.
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
nineteendo
reviewed
May 21, 2024
Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
nineteendo
reviewed
May 21, 2024
Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
|
The following commit authors need to sign the Contributor License Agreement: |
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.
The current
simple_stmts.html#the-assert-statementtext mentions -O as a tiny hyperlink over to#cmdoption-Obut doesn't mention thePYTHONOPTIMIZEenvironment variable. This commit adds a hyperlink to it and adds a note warning of breaking logic when using assert statements in code. Fixes #115177📚 Documentation preview 📚: https://cpython-previews--119305.org.readthedocs.build/