Skip to content
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

gh-100556: Better or doc wording #100589

Merged
merged 5 commits into from
Feb 21, 2023
Merged

gh-100556: Better or doc wording #100589

merged 5 commits into from
Feb 21, 2023

Conversation

ramvikrams
Copy link
Contributor

gh-100556: changed the or documentation

Copy link

@AlexandroLuis AlexandroLuis left a comment

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

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

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

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

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

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

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

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.

Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
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
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

Thanks for the PR @ramvikrams

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

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
(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

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
(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

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
(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
(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

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

@erlend-aasland
Copy link
Contributor

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
* 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

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
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
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
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants