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-92417: fractions
, decimal
: Improve docs for alternative constructor methods
#92421
base: main
Are you sure you want to change the base?
Conversation
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.
fractions
docs: remove references to Python <3.2fractions
, decimal
: Improve docs for alternative constructor methods
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
It would be nice if some math people (like @mdickinson, or @rhettinger, or @tim-one, or @skrah) take a look at it. |
I'll give this a thorough review when I get a chance. Off-hand, it looks like an aggressive edit. |
I am not sure that they can be considered legacy methods. They are useful if you want to restrict the type of the input. I even proposed to add alternate restricted constructors for other numeric types (for example see #26827). |
I'm happy to remove the notes I added in 8f537ea, but I'll defer to you and @mdickinson on whether that's a good idea or not :) |
I definitely see a case for restricting to numeric input (as opposed to |
I'm in favour of having the information about the danger of |
That may be simplest for this PR. |
I've reverted the addition of the notes saying that they are legacy methods (cc. @serhiy-storchaka). |
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 And if you don't make the requested changes, you will be put in the comfy chair! |
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. |
Thanks for making the requested changes! @serhiy-storchaka, @mdickinson, @rhettinger: please review the changes made to this pull request. |
Agreed. Raymond's assigned this to himself, so I'll duck out at this point and leave this to you and him. |
@rhettinger, is there anything more you'd like me to do here? :) (I don't have merge privileges; I'm only a triager.) |
#92417