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

gh-92417: fractions, decimal: Improve docs for alternative constructor methods #92421

Merged
merged 10 commits into from
May 19, 2022
Merged

gh-92417: fractions, decimal: Improve docs for alternative constructor methods #92421

merged 10 commits into from
May 19, 2022

Conversation

AlexWaygood
Copy link
Member

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 7, 2022
@AlexWaygood AlexWaygood mentioned this pull request May 7, 2022
Closed
@AlexWaygood AlexWaygood added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels May 7, 2022
serhiy-storchaka
serhiy-storchaka reviewed May 8, 2022
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove the note directive at all. It attracts too much attention. Instead I would add something like "This is a limited version of the :class:`Fraction` constructor which only accepts :class:`~numbers.Integral` or :class:`float`." in plain paragraph.

Replace the method directive with classmethod for class methods.

And the same should be done for Decimal. It would be better to do all this in a single PR.

@AlexWaygood AlexWaygood marked this pull request as draft May 8, 2022 05:05
@AlexWaygood AlexWaygood added the needs backport to 3.11 only security fixes label May 8, 2022
@AlexWaygood AlexWaygood changed the title gh-92417: fractions docs: remove references to Python <3.2 gh-92417: fractions, decimal: Improve docs for alternative constructor methods May 8, 2022
serhiy-storchaka
serhiy-storchaka reviewed May 8, 2022
View reviewed changes
@AlexWaygood AlexWaygood marked this pull request as ready for review May 8, 2022 17:44
@AlexWaygood AlexWaygood requested a review from rhettinger as a code owner May 8, 2022 17:44
@AlexWaygood @ezio-melotti
More doctest
f519d0a 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@serhiy-storchaka
Copy link
Member

It would be nice if some math people (like @mdickinson, or @rhettinger, or @tim-one, or @skrah) take a look at it.

mdickinson
mdickinson reviewed May 9, 2022
View reviewed changes
mdickinson
mdickinson reviewed May 9, 2022
View reviewed changes
Copy link
Member

@mdickinson mdickinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One nitpick; otherwise, the changes look good to me.

mdickinson
mdickinson reviewed May 9, 2022
View reviewed changes
@rhettinger rhettinger self-assigned this May 9, 2022
rhettinger
rhettinger requested changes May 9, 2022
View reviewed changes
@bedevere-bot
Copy link

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.

And if you don't make the requested changes, you will be put in the comfy chair!

@AlexWaygood
Copy link
Member Author

Thanks all for the reviews! I feel like I've received slightly contradictory feedback on this, and it was certainly never my intent to make an aggressive edit, so I've reduced the PR down to a minimal diff which should hopefully be less controversial.

I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@serhiy-storchaka, @mdickinson, @rhettinger: please review the changes made to this pull request.

@mdickinson
Copy link
Member

I feel like I've received slightly contradictory feedback on this

Agreed. Raymond's assigned this to himself, so I'll duck out at this point and leave this to you and him.

@mdickinson mdickinson removed their request for review May 10, 2022 18:36
@AlexWaygood
Copy link
Member Author

@rhettinger, is there anything more you'd like me to do here? :)

(I don't have merge privileges; I'm only a triager.)

@ambv ambv merged commit 090df84 into python:main May 19, 2022
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

GH-92970 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 May 19, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 19, 2022
@AlexWaygood @miss-islington
pythongh-92417: fractions, decimal: Improve docs for alternative …
d7c2aab 
…constructor methods (pythonGH-92421)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df84)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 19, 2022
@AlexWaygood @miss-islington
pythongh-92417: fractions, decimal: Improve docs for alternative …
52cdb22 
…constructor methods (pythonGH-92421)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df84)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot
Copy link

GH-92971 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 May 19, 2022
@AlexWaygood AlexWaygood deleted the patch-5 branch May 19, 2022 15:29
ambv pushed a commit that referenced this pull request May 19, 2022
@miss-islington @AlexWaygood
gh-92417: fractions, decimal: Improve docs for alternative constr…
02fe225 
…uctor methods (GH-92421) (GH-92970)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df84)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
ambv pushed a commit that referenced this pull request May 19, 2022
@miss-islington @AlexWaygood
gh-92417: fractions, decimal: Improve docs for alternative constr…
93ebac7 
…uctor methods (GH-92421) (GH-92971)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df84)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ezio-melotti ezio-melotti ezio-melotti left review comments

@mdickinson mdickinson mdickinson approved these changes

@rhettinger rhettinger rhettinger approved these changes

@serhiy-storchaka serhiy-storchaka Awaiting requested review from serhiy-storchaka

Assignees

@rhettinger rhettinger

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@AlexWaygood @serhiy-storchaka @rhettinger @mdickinson @bedevere-bot @miss-islington @ezio-melotti @ambv