Skip to content

gh-100556: Better or doc wording #100589

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.

Sign up for GitHub

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

Jump to bottom
Merged
erlend-aasland merged 5 commits into from
Feb 21, 2023
Merged

gh-100556: Better or doc wording #100589

erlend-aasland merged 5 commits into from
Feb 21, 2023

Conversation

@ramvikrams
Copy link
Contributor

@ramvikrams ramvikrams commented Dec 28, 2022

gh-100556: changed the or documentation
@bedevere-bot bedevere-bot mentioned this pull request Dec 28, 2022
Closed
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Dec 28, 2022
AlexandroLuis
AlexandroLuis suggested changes Dec 29, 2022
View reviewed changes
Copy link

@AlexandroLuis AlexandroLuis left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i wonder how and works if there's no comparison
just
if x is false: x else: y
and not
if x is True and y is True: True else: False
@ramvikrams
Copy link
Contributor Author

ramvikrams commented Dec 29, 2022

i wonder how and works if there's no comparison
just
if x is false: x else: y
and not
if x is True and y is True: True else: False

Thanks will do the change
slateny
slateny reviewed Dec 30, 2022
View reviewed changes
Doc/library/stdtypes.rst Outdated
| | *y* | |
+-------------+---------------------------------+-------+
| ``x and y`` | if *x* is True and *y* is True, | \(2) |
| | then True, else False | |
Copy link
Contributor

@slateny slateny Dec 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you misunderstood the other comment, as this now doesn't cover something like

>>> [] and [1] []
Copy link
Contributor Author

@ramvikrams ramvikrams Dec 30, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please tell then how should it be framed, bcoz I am not able to think of it
Copy link

@AlexandroLuis AlexandroLuis Dec 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if x and y, then True, else False

it covers if it's Null, empty, False...
Copy link
Contributor Author

@ramvikrams ramvikrams Dec 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks i'll do it
Copy link
Contributor

@slateny slateny Dec 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original mention of 'true'/'false' refers to all truthy and falsey values, which include 0, None, empty lists, etc., and saying True excludes those as True refers to just the boolean value. I also don't think that it's all that helpful for a table to have an entry to say x and y then its explanation also say x and y, so I would actually recommend just sticking with the original for this and section.
hugovk
hugovk reviewed Dec 31, 2022
View reviewed changes
@ramvikrams @hugovk
Update Doc/library/stdtypes.rst
83e83ed 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@CAM-Gerlach CAM-Gerlach added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Feb 21, 2023
CAM-Gerlach
CAM-Gerlach approved these changes Feb 21, 2023
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM IMO; it avoids a double negative (if false, else) and the order follows more closely with that of the expression itself
@erlend-aasland
Copy link
Contributor

erlend-aasland commented Feb 21, 2023

Thanks for the PR @ramvikrams
@erlend-aasland erlend-aasland merged commit b40dd71 into python:main Feb 21, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Feb 21, 2023

Thanks @ramvikrams for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 21, 2023
@ramvikrams @hugovk @miss-islington
pythongh-100556: Improve clarity of or docs (pythonGH-100589)
57ba8e6 
(cherry picked from commit b40dd71) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot
Copy link

bedevere-bot commented Feb 21, 2023

GH-102108 is a backport of this pull request to the 3.11 branch.
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 21, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 21, 2023
@ramvikrams @hugovk @miss-islington
pythongh-100556: Improve clarity of or docs (pythonGH-100589)
4c9a446 
(cherry picked from commit b40dd71) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot
Copy link

bedevere-bot commented Feb 21, 2023

GH-102109 is a backport of this pull request to the 3.10 branch.
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Feb 21, 2023
miss-islington added a commit that referenced this pull request Feb 21, 2023
@miss-islington @ramvikrams @hugovk
gh-100556: Improve clarity of or docs (GH-100589)
444ec74 
(cherry picked from commit b40dd71) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Feb 21, 2023
@miss-islington @ramvikrams @hugovk
gh-100556: Improve clarity of or docs (GH-100589)
a94f3ad 
(cherry picked from commit b40dd71) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@CAM-Gerlach CAM-Gerlach changed the title gh-100556: Better or doc working gh-100556: Better or doc wording Feb 22, 2023
@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Feb 22, 2023

Oops, forgot to fix the title...hope you fixed it in the commit message :)
@erlend-aasland
Copy link
Contributor

erlend-aasland commented Feb 22, 2023

Oops, forgot to fix the title...hope you fixed it in the commit message :)

I did... hope you like it 😄 b40dd71
I'll do better next time!
carljm added a commit to carljm/cpython that referenced this pull request Feb 23, 2023
@carljm
Merge branch 'main' into lockfreecp
b257a16 
* main: (76 commits) Fix syntax error in struct doc example (python#102160) pythongh-99108: Import MD5 and SHA1 from HACL* (python#102089) pythonGH-101777: `queue.rst`: use 2 spaces after a period to be consistent. (python#102143) Few coverage nitpicks for the cmath module (python#102067) pythonGH-100982: Restrict `FOR_ITER_RANGE` to a single instruction to allow instrumentation. (pythonGH-101985) pythongh-102135: Update turtle docs to rename wikipedia demo to rosette (python#102137) pythongh-99942: python.pc on android/cygwin should link to libpython per configure.ac (pythonGH-100356) pythongh-95672 fix typo SkitTest to SkipTest (pythongh-102119) pythongh-101936: Update the default value of fp from io.StringIO to io.BytesIO (pythongh-102100) pythongh-102008: simplify test_except_star by using sys.exception() instead of sys.exc_info() (python#102009) pythongh-101903: Remove obsolete undefs for previously removed macros Py_EnterRecursiveCall and Py_LeaveRecursiveCall (python#101923) pythongh-100556: Improve clarity of `or` docs (python#100589) pythongh-101777: Make `PriorityQueue` docs slightly clearer (python#102026) pythongh-101965: Fix usage of Py_EnterRecursiveCall return value in _bisectmodule.c (pythonGH-101966) pythongh-101578: Amend exception docs (python#102057) pythongh-101961 fileinput.hookcompressed should not set the encoding value for the binary mode (pythongh-102068) pythongh-102056: Fix a few bugs in error handling of exception printing code (python#102078) pythongh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (python#102012) pythongh-101566: Sync with zipp 3.14. (pythonGH-102018) pythonGH-99818: improve the documentation for zipfile.Path and Traversable (pythonGH-101589) ...
@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Feb 23, 2023

Oh, that's fine then of course :) At least for me updating the title-generated commit message updates the PR title as well, but it seems that's actually GitHub Refined rather than a builtin feature (I never know these days, heh)
python-sidebar pushed a commit to python-sidebar/Python-Documentation-Fork-With-TOC that referenced this pull request Sep 1, 2024
@ramvikrams @hugovk @python-sidebar
pythongh-100556: Improve clarity of or docs (python#100589)
9fb4ef8 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
python-sidebar pushed a commit to python-sidebar/Python-Documentation-Fork-With-TOC that referenced this pull request Sep 1, 2024
@ramvikrams @hugovk @python-sidebar
pythongh-100556: Improve clarity of or docs (python#100589)
75260af 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this pull request Sep 10, 2024
@ramvikrams @hugovk @JelleZijlstra
pythongh-100556: Improve clarity of or docs (python#100589)
3d5a88e 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

8 participants

@ramvikrams @erlend-aasland @miss-islington @bedevere-bot @CAM-Gerlach @hugovk @slateny @AlexandroLuis