gh-65058 Revised conditional expression with additional context and examples for issue #119171

mas192 · 2024-05-19T05:45:11Z

…r right to left precedence

📚 Documentation preview 📚: https://cpython-previews--119171.org.readthedocs.build/

Issue: Context of documentation for conditional expressions #65058

…r right to left precedence

ghost · 2024-05-19T05:45:13Z

All commit authors signed the Contributor License Agreement.

…ting.

nineteendo · 2024-05-19T06:52:37Z

Doc/reference/expressions.rst

-their suffixes::
+their suffixes:
+
+   .. code-block:: python


You can just keep the ::, it automatically creates a code block.

A explicit code block has better emphasis compared to to the :
Additionally too keep it consistent with the examples I wrote above 1927 I assumed its worth changing line 1927 too.
If you think is not needed should I revise and push again?

Only 18 files use .. code-block:: python, while 460 use ::. So, I think it's best to use ::.

Thank you for pointing out to the inconsistencies. Since, .. code-block:: python
has better emphasis overall compared to ::
I don't mind refactoring all the 460 instances of ::
that said I would like to hear from a member of cpython team as well on the best course of action!

... just use ::. The indented block is clear enough.

The original pr I made was for adding examples and clarity to the documentation. I will wait for a member to review and approve or comment on that before I make any more changes. Thanks for the feedback

Personally, I prefer .. code-block:: python when the snippets are long enough or if I don't want a colon to open my code-block (in this case, I however would prefer to keep a smaller diff since the changes are only cosmetics and we prefer not having cosmetic changes).

There is a difference between :: and .. code-block:: python. The first one uses the default highlighting and automatically adds a colon at the end of the sentence, namely this makes

Hello:: ...

equivalent to

Hello: .. code-block:: ...

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks.

nineteendo · 2024-05-20T17:51:27Z

You should only merge with master to fix merge conflicts, or if you need something that was just added.

mas192 · 2024-05-20T17:58:12Z

got it thanks

vadmium · 2024-10-05T08:52:16Z

Doc/reference/expressions.rst

+Notice that while evaluating an assignment, the right-hand side is evaluated before
+the left-hand side.
+
+Examples for left to right:


Perhaps “Example [singular] of left-to-right grouping 1�7?

vadmium · 2024-10-05T08:52:20Z

Doc/reference/expressions.rst


-Python evaluates expressions from left to right.  Notice that while evaluating
-an assignment, the right-hand side is evaluated before the left-hand side.
+Python evaluates expressions from left to right (except for conditional_expression).


Everywhere else the existing text just refers to them as conditional expressions in plural and without the underscore.

I’m not sure pointing out conditional expressions as the only exception is much better. Perhaps it should be except for conditional and exponentiation expressions?.

I think this sentence confuses the usage of evaluates. Perhaps we actually mean groups expressions? Compare the use of evaluate in the next sentence, meaning finding the value of operands. But then we’d be just repeating the “Operators . . . group 1�7 sentence in from the next section. Otherwise, see Terry’s 2nd point in #65058, about evaluating the middle first.

Perhaps it should be except for conditional and exponentiation expressions?

Why do you think so?

>>> class A: ... def __add__(self, other): ... print("Hi, from A!") ... return 1.23 ... class B: ... def __add__(self, other): ... print("Hi, from B!") ... return 3.21 ... >>> (A() + A())**(B() + B()) Hi, from A! Hi, from B! 1.9435486122336787

Ah sorry I was confused. Perhaps the “left to right except conditional 1�7 got me thinking “conditional expressions must be the opposite, right to left 1�7 and therefore we must be talking about grouping, not evaluation.

vadmium · 2024-10-05T09:05:43Z

Doc/reference/expressions.rst

+   .. code-block:: python
+
+       'foo' if 1 else 'bar' if 0 else 'baz'
+       'foo'


I wonder if these would be clearer if they included the interactive prompt >>>

vadmium · 2024-10-05T09:07:19Z

Doc/reference/expressions.rst

+      2 + 3 * 4 / 2 - 1
+      7
+
+Following is an example of right to left conditional_expression evaluation example:


Example of right-to-left conditional expression grouping

vadmium · 2024-10-05T09:14:03Z

Doc/reference/expressions.rst

+comparisons, including tests, exponentiation and conditional expressions, which
+group from right to left which all have the same precedence and chain from left
+to right  1�7 see section Comparisons  1�7 and exponentiation, which groups from right
+to left)


Exponentiation listed twice. The exceptions don’t all have the same precedence. Partially redundant with the paragraph below.

revised conditonal expression with additional context and examples fo 1�7

9298051

…r right to left precedence

bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels May 19, 2024

Fix trailing whitespace in expressions.rst

a285684

mas192 changed the title ~~Revised conditional expression with additional context and examples for issue #65058~~ gh-65058 Revised conditional expression with additional context and examples for issue May 19, 2024

bedevere-app bot mentioned this pull request May 19, 2024

Context of documentation for conditional expressions #65058

Open

Revised the examples for evaluation order to ensure consistent format 1�7

8beb707

…ting.

mas192 force-pushed the main branch from 2c1b995 to 8beb707 Compare May 19, 2024 06:22

nineteendo reviewed May 19, 2024

View reviewed changes

mas192 added 4 commits May 19, 2024 22:32

Merge branch 'main' into main

1a98e9e

Merge branch 'main' into main

a461ca6

Merge branch 'main' into main

137c275

Merge branch 'main' into main

9341d0f

vadmium reviewed Oct 5, 2024

View reviewed changes

Uh oh!

gh-65058 Revised conditional expression with additional context and examples for issue #119171

Are you sure you want to change the base?

gh-65058 Revised conditional expression with additional context and examples for issue #119171

Uh oh!

Conversation

mas192 commented May 19, 2024 • edited by bedevere-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented May 19, 2024 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

picnixz Oct 5, 2024 • 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!

nineteendo commented May 20, 2024

Uh oh!

mas192 commented May 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vadmium Oct 5, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mas192 commented May 19, 2024 •

edited by bedevere-app bot

Loading

ghost commented May 19, 2024 •

edited by ghost

Loading

picnixz Oct 5, 2024 •

edited

Loading

mas192 commented May 20, 2024 •

edited

Loading

vadmium Oct 5, 2024 •

edited

Loading