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.

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

Better or doc wording #100556

Closed
pochmann opened this issue Dec 27, 2022 · 0 comments
Closed

Better or doc wording #100556

pochmann opened this issue Dec 27, 2022 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@pochmann
Copy link
Contributor

pochmann commented Dec 27, 2022 •
edited by bedevere-bot
Loading

Documentation

x or y is documented as:

if x is false, then y, else x

That looks unnatural/backwards/negated to me. It's not how I think of it. I suggest:

if x is true, then x, else y

Linked PRs
@pochmann pochmann added the docs Documentation in the Doc dir label Dec 27, 2022
@ramvikrams ramvikrams mentioned this issue Dec 28, 2022
Merged
erlend-aasland pushed a commit that referenced this issue Feb 21, 2023
@ramvikrams @hugovk
gh-100556: Improve clarity of or docs (#100589)
b40dd71 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue 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 bedevere-bot mentioned this issue Feb 21, 2023
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue 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 bedevere-bot mentioned this issue Feb 21, 2023
Merged
miss-islington added a commit that referenced this issue 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 issue 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>
carljm added a commit to carljm/cpython that referenced this issue 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)
  ...
python-sidebar pushed a commit to python-sidebar/Python-Documentation-Fork-With-TOC that referenced this issue 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 issue 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 issue 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
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pochmann @erlend-aasland