[issue30940] Documentation for round() is incorrect.

Change by Serhiy Storchaka : -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python tracker

[issue30940] Documentation for round() is incorrect.

miss-islington added the comment: New changeset 82c9adb3f94e5d889f03205d03a76a5ff0928531 by Miss Islington (bot) in branch '3.6': bpo-30940: Updating round() docs. (GH-6342)

[issue30940] Documentation for round() is incorrect.

Serhiy Storchaka added the comment: New changeset 736e3b32194b52b1779ce88a2c13862f0f913a7a by Serhiy Storchaka (Miss Islington (bot)) in branch '3.7': bpo-30940: Updating round() docs. (GH-6342) (GH-7009)

[issue30940] Documentation for round() is incorrect.

Change by miss-islington : -- pull_requests: +6660 ___ Python tracker ___

[issue30940] Documentation for round() is incorrect.

Change by miss-islington : -- pull_requests: +6659 ___ Python tracker ___

[issue30940] Documentation for round() is incorrect.

Serhiy Storchaka added the comment: New changeset 900c48dba3f3eb8fb03ea766a5646f81c3bf3e9c by Serhiy Storchaka (Lisa Roach) in branch 'master': bpo-30940: Updating round() docs. (GH-6342)

[issue30940] Documentation for round() is incorrect.

Change by Lisa Roach : -- keywords: +patch pull_requests: +6053 ___ Python tracker ___

[issue30940] Documentation for round() is incorrect.

Change by Raymond Hettinger : -- assignee: docs@python -> lisroach nosy: +lisroach ___ Python tracker ___

[issue30940] Documentation for round() is incorrect.

Ned Deily added the comment: This issue seems to have slipped through the cracks with a couple of long-standing PR's open. Anyone feel up to finishing it? -- nosy: +ned.deily stage: needs patch -> patch review versions: +Python 3.8 -Python 3.5

[issue30940] Documentation for round() is incorrect.

Changes by Roundup Robot : -- pull_requests: +3300 ___ Python tracker ___

[issue30940] Documentation for round() is incorrect.

Mark Dickinson added the comment: > This also can be not clear. Sure. But if it comes down to a clear, mostly accurate description that helps people understand versus a harder-to-read nitpick-proof statement, I'd rather see the former. -- ___

[issue30940] Documentation for round() is incorrect.

Serhiy Storchaka added the comment: > For a general Python object ``number``, ``round`` delegates to > ``number.__round__``. This also can be not clear. See a discussion in issue31042. -- ___ Python tracker

[issue30940] Documentation for round() is incorrect.

Mark Dickinson added the comment: [Serhiy] > is it worth to mention explicitly that round(number) and round(number, None) > > delegate to number.__round__()? Yes, if we can find a non-clunky wording that does that. The current wording does seem to misleadingly suggest that the delegation to

[issue30940] Documentation for round() is incorrect.

Serhiy Storchaka added the comment: In the documentation: For a general Python object ``number``, ``round(number, ndigits)`` delegates to ``number.__round__(ndigits)``. Mark, is it worth to mention explicitly that round(number) and round(number, None) delegate to number.__round__()?

[issue30940] Documentation for round() is incorrect.

Changes by Mandeep Singh : -- pull_requests: +2876 ___ Python tracker ___ ___

[issue30940] Documentation for round() is incorrect.

Serhiy Storchaka added the comment: The documentation should be updated before converting round() to Argument Clinic, because this update should be backported to 3.6 and 3.5, while the conversion can be made only in 3.7. -- keywords: +easy stage: -> needs patch

[issue30940] Documentation for round() is incorrect.

Mark Dickinson added the comment: Ah, sorry; I see. That was just for the docstring, not for the docs. My bad. -- ___ Python tracker ___

[issue30940] Documentation for round() is incorrect.

Mark Dickinson added the comment: Serhiy: I thought your GitHub PR (https://github.com/python/cpython/pull/2740) already included the new wording? -- ___ Python tracker

[issue30940] Documentation for round() is incorrect.

R. David Murray added the comment: We don't need to burden Mark with doing a PR for this (unless he wants to). This is a good new contributer practice issue :) -- nosy: +r.david.murray ___ Python tracker

[issue30940] Documentation for round() is incorrect.

Serhiy Storchaka added the comment: Could you please make a PR for your suggestion Mark? -- ___ Python tracker ___

[issue30940] Documentation for round() is incorrect.

Mark Dickinson added the comment: Sure, fine with me to add AC support for round. -- ___ Python tracker ___

[issue30940] Documentation for round() is incorrect.

Raymond Hettinger added the comment: > I prepared a patch for this but wanted to make sure this is a desirable > behavior. That seems reasonable to me. Mark, what do you think? -- ___ Python tracker

[issue30940] Documentation for round() is incorrect.

Serhiy Storchaka added the comment: round() was not converted to Argument Clinic. There is a special comment about this: /* AC: cannot convert yet, as needs PEP 457 group support in inspect * or a semantic change to accept None for "ndigits" */ *Now* round() can be converted to Argument

[issue30940] Documentation for round() is incorrect.

Raymond Hettinger added the comment: > Wasn't this change a mistake? Now that it is deployed, it should probably be left alone (it is has to take back an API change), but this should be a cautionary note for arg-clinic enthusiasts to not change existing APIs. When Argument Clinic is too

[issue30940] Documentation for round() is incorrect.

Mark Dickinson added the comment: [Serhiy] > Wasn't this change a mistake? Seems Mark opposed to it. Shrug. It seemed unnecessary to me to explicitly support `None` as a second argument, but it's done now; reverting the change at this point would do more harm than good. So indeed there's a

[issue30940] Documentation for round() is incorrect.

Serhiy Storchaka added the comment: In 3.4 round() doesn't accept None as ndigits argument. The behavior was changed by issue19933 and issue27936. Wasn't this change a mistake? Seems Mark opposed to it. -- nosy: +mark.dickinson, rhettinger, serhiy.storchaka, steve.dower versions:

[issue30940] Documentation for round() is incorrect.

New submission from George K: The documentation for round states "The return value is an integer if called with one argument, otherwise of the same type as number." This is not the case if the second argument is None. -- assignee: docs@python components: Documentation messages: 298442