-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
doc: use less ambiguously named variable #113113
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Labels
docs
Documentation in the Doc dir
Comments
rhettinger
pushed a commit
that referenced
this issue
Dec 14, 2023
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Dec 14, 2023
…13114) (cherry picked from commit fb4cb7c) Co-authored-by: jeremy-dolan <[email protected]>
rhettinger
pushed a commit
that referenced
this issue
Dec 14, 2023
corona10
pushed a commit
to corona10/cpython
that referenced
this issue
Dec 15, 2023
aisk
pushed a commit
to aisk/cpython
that referenced
this issue
Feb 11, 2024
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this issue
Sep 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Documentation
In the control flow tutorial -- https://docs.python.org/3/tutorial/controlflow.html -- one of the examples uses 'ok' as the variable name to capture input(). 'Ok' is ambiguous and, at least to me, read as a boolean type when I was learning python with the tutorials. Since the following code processes
ok
with some Python-specific syntax (a container check against a tuple of strings), as a new user it was hard to understand what was going on. I propose changing the variable name to 'reply' to more clearly indicate to the tutorial reader that it's storing unevaluated user input, without the affirmative connotations of the name 'ok'. PR forthcoming.Example in question:
Linked PRs
The text was updated successfully, but these errors were encountered: