doc: Mention the missing reflected operations #119931

paulofreitas · 2024-06-02T02:37:51Z

Just a minor doc update to maintain consistency with other reflected operations documented in reference/expressions. 👍

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

To maintain consistency with other arithmetic operations.

ghost · 2024-06-02T02:37:53Z

All commit authors signed the Contributor License Agreement.

Eclips4

Thanks!

Doc/reference/expressions.rst

Co-authored-by: Mark Dickinson <[email protected]>

serhiy-storchaka

There is also the same issue for __rpow__, __rtruediv__, __rfloordiv__, __rmod__, __rlshift__, __rrshift__, and maybe others.

It is better to fix them all in a single PR.

Alternatively, we can remove references to __radd__ and __rmul__.

bedevere-app · 2024-06-02T13:02:18Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Add links to `__rpow__`, `__rtruediv__`, `__rfloordiv__`, `__rmod__`, `__rlshift__` and `__rrshift__`.

paulofreitas · 2024-06-02T13:47:48Z

There is also the same issue for __rpow__, __rtruediv__, __rfloordiv__, __rmod__, __rlshift__, __rrshift__, and maybe others.

It is better to fix them all in a single PR.

Alternatively, we can remove references to __radd__ and __rmul__.

Note that __rand__, __rxor__ and __ror__ were also documented. I went with the first suggestion and added the other missing reflected operations. 👍

serhiy-storchaka

For divisions and shifts, I think that it is better to be explicit what dunder customizes what operator.

While we are here, I think it is worth to document also the dunders for the @ operator.

As per review request, improved shifting operators wording and added `@` operators. 👍

paulofreitas · 2024-06-02T15:02:36Z

For divisions and shifts, I think that it is better to be explicit what dunder customizes what operator.

While we are here, I think it is worth to document also the dunders for the @ operator.

Hope I covered both things as intended. 👍

serhiy-storchaka · 2024-06-02T15:15:07Z

Doc/reference/expressions.rst

@@ -1314,8 +1318,9 @@ integer; the result is that of mathematical division with the 'floor' function
 applied to the result.  Division by zero raises the :exc:`ZeroDivisionError`
 exception.

-This operation can be customized using the special :meth:`~object.__truediv__` and
-:meth:`~object.__floordiv__` methods.
+This operation can be customized using the special :meth:`~object.__truediv__`,


There are two different operations.

There are two different operations.

Nice catch, I was forgetting this one. 👍

serhiy-storchaka · 2024-06-04T14:57:13Z

Doc/reference/expressions.rst

-:meth:`~object.__rshift__` methods.
+The left shift operation can be customized using the special :meth:`~object.__lshift__`
+and :meth:`~object.__rlshift__` methods.
+


Would not be better to merge these two paragraphs?

Suggested change

For sure, merged it and did the same formatting for division and floor division operations. 👍

Separates division and floor division and remove spacing from shifting operations.

serhiy-storchaka

LGTM.

Thank you for your contribution @paulofreitas.

miss-islington-app · 2024-06-04T17:55:15Z

Thanks @paulofreitas for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

…rations (pythonGH-119931) (cherry picked from commit bf5e106) Co-authored-by: Paulo Freitas <[email protected]>

bedevere-app · 2024-06-04T17:55:25Z

GH-120063 is a backport of this pull request to the 3.13 branch.

…rations (pythonGH-119931) (cherry picked from commit bf5e106) Co-authored-by: Paulo Freitas <[email protected]>

bedevere-app · 2024-06-04T17:55:30Z

GH-120064 is a backport of this pull request to the 3.12 branch.

paulofreitas · 2024-06-04T19:11:57Z

LGTM.

Thank you for your contribution @paulofreitas.

Thank you for all your help reviewing! Glad to contribute here, looking forward to contribute more! 🎉 🐍

serhiy-storchaka · 2024-06-04T19:14:09Z

Looking forward to review more your PRs.

…rations (pythonGH-119931)

…ary operations (GH-119931) (#120063) doc: Mention the missing reflected special methods for all binary operations (GH-119931) (cherry picked from commit bf5e106) Co-authored-by: Paulo Freitas <[email protected]>

…ary operations (GH-119931) (#120064) doc: Mention the missing reflected special methods for all binary operations (GH-119931) (cherry picked from commit bf5e106) Co-authored-by: Paulo Freitas <[email protected]>

…rations (pythonGH-119931)

Mention __rsub__ arithmetic operation

baa52ba

To maintain consistency with other arithmetic operations.

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

Eclips4 added skip issue needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Jun 2, 2024

Eclips4 approved these changes Jun 2, 2024

View reviewed changes

bedevere-app bot added awaiting core review and removed awaiting review labels Jun 2, 2024

mdickinson reviewed Jun 2, 2024

View reviewed changes

Doc/reference/expressions.rst Outdated Show resolved Hide resolved

mdickinson reviewed Jun 2, 2024

View reviewed changes

Doc/reference/expressions.rst Outdated Show resolved Hide resolved

Update Doc/reference/expressions.rst

e99d7ad

Co-authored-by: Mark Dickinson <[email protected]>

serhiy-storchaka requested changes Jun 2, 2024

View reviewed changes

bedevere-app bot added awaiting changes and removed awaiting core review labels Jun 2, 2024

Add the other reflected methods

8f666a0

Add links to `__rpow__`, `__rtruediv__`, `__rfloordiv__`, `__rmod__`, `__rlshift__` and `__rrshift__`.

paulofreitas changed the title ~~doc: Mention __rsub__ arithmetic operation~~ doc: Mention the missing reflected operations Jun 2, 2024

Merge branch 'main' into rsub-arithmetic-operation

b8cee56

serhiy-storchaka reviewed Jun 2, 2024

View reviewed changes

Improved shifting operators and added @ operators

646a125

As per review request, improved shifting operators wording and added `@` operators. 👍

Merge branch 'main' into rsub-arithmetic-operation

9b3bd75

paulofreitas requested a review from serhiy-storchaka June 4, 2024 14:54

serhiy-storchaka reviewed Jun 4, 2024

View reviewed changes

paulofreitas added 2 commits June 4, 2024 12:22

Separate division and floor division

89cc08e

Separates division and floor division and remove spacing from shifting operations.

Merge branch 'main' into rsub-arithmetic-operation

3fc42e3

serhiy-storchaka approved these changes Jun 4, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting changes labels Jun 4, 2024

serhiy-storchaka enabled auto-merge (squash) June 4, 2024 17:47

serhiy-storchaka merged commit bf5e106 into python:main Jun 4, 2024
26 of 27 checks passed

bedevere-app bot removed the awaiting merge label Jun 4, 2024

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jun 4, 2024

bedevere-app bot removed the needs backport to 3.12 only security fixes label Jun 4, 2024

paulofreitas deleted the rsub-arithmetic-operation branch June 4, 2024 19:12

barneygale pushed a commit to barneygale/cpython that referenced this pull request Jun 5, 2024

doc: Mention the missing reflected special methods for all binary ope…

59e59db

…rations (pythonGH-119931)

noahbkim pushed a commit to hudson-trading/cpython that referenced this pull request Jul 11, 2024

doc: Mention the missing reflected special methods for all binary ope…

d49cd99

…rations (pythonGH-119931)

estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024

doc: Mention the missing reflected special methods for all binary ope…

c982bd5

…rations (pythonGH-119931)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Mention the missing reflected operations #119931

doc: Mention the missing reflected operations #119931

paulofreitas commented Jun 2, 2024 •

edited

Loading

ghost commented Jun 2, 2024 •

edited by ghost

Loading

Eclips4 left a comment

serhiy-storchaka left a comment

bedevere-app bot commented Jun 2, 2024

paulofreitas commented Jun 2, 2024

serhiy-storchaka left a comment

paulofreitas commented Jun 2, 2024

serhiy-storchaka Jun 2, 2024

paulofreitas Jun 4, 2024

serhiy-storchaka Jun 4, 2024

paulofreitas Jun 4, 2024

serhiy-storchaka left a comment

miss-islington-app bot commented Jun 4, 2024

bedevere-app bot commented Jun 4, 2024

bedevere-app bot commented Jun 4, 2024

paulofreitas commented Jun 4, 2024

serhiy-storchaka commented Jun 4, 2024

doc: Mention the missing reflected operations #119931

doc: Mention the missing reflected operations #119931

Conversation

paulofreitas commented Jun 2, 2024 • edited Loading

ghost commented Jun 2, 2024 • edited by ghost Loading

Eclips4 left a comment

Choose a reason for hiding this comment

serhiy-storchaka left a comment

Choose a reason for hiding this comment

bedevere-app bot commented Jun 2, 2024

paulofreitas commented Jun 2, 2024

serhiy-storchaka left a comment

Choose a reason for hiding this comment

paulofreitas commented Jun 2, 2024

serhiy-storchaka Jun 2, 2024

Choose a reason for hiding this comment

paulofreitas Jun 4, 2024

Choose a reason for hiding this comment

serhiy-storchaka Jun 4, 2024

Choose a reason for hiding this comment

paulofreitas Jun 4, 2024

Choose a reason for hiding this comment

serhiy-storchaka left a comment

Choose a reason for hiding this comment

miss-islington-app bot commented Jun 4, 2024

bedevere-app bot commented Jun 4, 2024

bedevere-app bot commented Jun 4, 2024

paulofreitas commented Jun 4, 2024

serhiy-storchaka commented Jun 4, 2024

paulofreitas commented Jun 2, 2024 •

edited

Loading

ghost commented Jun 2, 2024 •

edited by ghost

Loading