gh-100556: Better `or` doc wording#100589

ramvikrams · 2022-12-28T17:24:22Z

gh-100556: changed the or documentation

AlexandroLuis

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 · 2022-12-29T15:29:25Z

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 · 2022-12-30T08:00:23Z

Doc/library/stdtypes.rst

 || *y* ||
 +-------------+---------------------------------+-------+
+| ``x and y`` | if *x* is True and *y* is True, |\(2) |
+|| then True, else False ||


I think you misunderstood the other comment, as this now doesn't cover something like
>>> [] and [1] []

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

if x and y, then True, else False
it covers if it's Null, empty, False...

thanks i'll do it

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.

Doc/library/stdtypes.rst

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

CAM-Gerlach

LGTM IMO; it avoids a double negative (if false, else) and the order follows more closely with that of the expression itself

erlend-aasland · 2023-02-21T10:34:26Z

Thanks for the PR @ramvikrams

miss-islington · 2023-02-21T10:35:01Z

Thanks @ramvikrams for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

(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 · 2023-02-21T10:35:12Z

GH-102108 is a backport of this pull request to the 3.11 branch.

(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 · 2023-02-21T10:35:17Z

GH-102109 is a backport of this pull request to the 3.10 branch.

(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 · 2023-02-22T00:10:02Z

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

erlend-aasland · 2023-02-22T15:39:13Z

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!

* 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 · 2023-02-23T03:00:17Z

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)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Update stdtypes.rst
4784262

bedevere-bot mentioned this pull request Dec 28, 2022
Better or doc wording #100556
Closed

bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Dec 28, 2022

AlexandroLuis suggested changes Dec 29, 2022
View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Dec 29, 2022

Update stdtypes.rst
985f3fd

slateny reviewed Dec 30, 2022
View reviewed changes

ramvikrams added 2 commits December 30, 2022 19:40

Update stdtypes.rst
ea77950

Update stdtypes.rst
254b699

hugovk reviewed Dec 31, 2022
View reviewed changes

Doc/library/stdtypes.rst Outdated Show resolvedHide resolved

Update Doc/library/stdtypes.rst
83e83ed
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

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 approved these changes Feb 21, 2023
View reviewed changes

erlend-aasland approved these changes Feb 21, 2023
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Feb 21, 2023

erlend-aasland merged commit b40dd71 into python:mainFeb 21, 2023

bedevere-bot removed the awaiting merge label Feb 21, 2023

bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 21, 2023

bedevere-bot removed the needs backport to 3.10 only security fixes label Feb 21, 2023

CAM-Gerlach changed the title ~~gh-100556: Better or doc working~~gh-100556: Better or doc wordingFeb 22, 2023

python-sidebar pushed a commit to python-sidebar/Python-Documentation-Fork-With-TOC that referenced this pull request Sep 1, 2024
pythongh-100556: Improve clarity ofordocs (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
pythongh-100556: Improve clarity ofordocs (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
pythongh-100556: Improve clarity ofordocs (python#100589)
3d5a88e
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Uh oh!

gh-100556: Better or doc wording#100589

gh-100556: Better or doc wording #100589

Uh oh!

Conversation

ramvikrams commented Dec 28, 2022

Uh oh!

AlexandroLuis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ramvikrams commented Dec 29, 2022

Uh oh!

slatenyDec 30, 2022

Choose a reason for hiding this comment

Uh oh!

ramvikramsDec 30, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexandroLuisDec 30, 2022

Choose a reason for hiding this comment

Uh oh!

ramvikramsDec 30, 2022

Choose a reason for hiding this comment

Uh oh!

slatenyDec 31, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

erlend-aasland commented Feb 21, 2023

Uh oh!

miss-islington commented Feb 21, 2023

Uh oh!

bedevere-bot commented Feb 21, 2023

Uh oh!

bedevere-bot commented Feb 21, 2023

Uh oh!

CAM-Gerlach commented Feb 22, 2023

Uh oh!

erlend-aasland commented Feb 22, 2023

Uh oh!

CAM-Gerlach commented Feb 23, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

gh-100556: Better `or` doc wording#100589

gh-100556: Better `or` doc wording #100589

AlexandroLuis left a comment •
edited
Loading

ramvikramsDec 30, 2022•
edited
Loading