Obsolete comments in docstrings in fractions module

[jmolinski]

BPO	36625
Nosy	@rhettinger, @mdickinson, @jmolinski
PRs	bpo-36625: Remove obsolete comments from docstrings in fractions module #12822

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-04-15.12:38:17.202>
created_at = <Date 2019-04-13.22:58:43.779>
labels = ['type-feature', '3.8', 'docs']
title = 'Obsolete comments in docstrings in fractions module'
updated_at = <Date 2019-04-15.12:38:17.202>
user = 'https://github.com/jmolinski'

bugs.python.org fields:

activity = <Date 2019-04-15.12:38:17.202>
actor = 'mark.dickinson'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-04-15.12:38:17.202>
closer = 'mark.dickinson'
components = ['Documentation']
creation = <Date 2019-04-13.22:58:43.779>
creator = 'jakub.molinski'
dependencies = []
files = []
hgrepos = []
issue_num = 36625
keywords = ['patch']
message_count = 3.0
messages = ['340174', '340196', '340269']
nosy_count = 4.0
nosy_names = ['rhettinger', 'mark.dickinson', 'docs@python', 'jakub.molinski']
pr_nums = ['12822']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue36625'
versions = ['Python 3.8']

[jmolinski]

3 docstrings in fractions.Fraction contain comments referring to python 3.0.

def __floor__(a):
    """Will be math.floor(a) in 3.0."""

def __ceil__(a):
    """Will be math.ceil(a) in 3.0."""

def __round__(self, ndigits=None):
    """Will be round(self, ndigits) in 3.0.

Rounds half toward even.
"""

To make it consistent with other docstrings in the module these should be changed to """math.floor(a)""", """math.ceil(a)""", and
"""round(self, ndigits)

Rounds half toward even.
"""

[mdickinson]

Agreed that these should be fixed.

[mdickinson]

New changeset a9a2880 by Mark Dickinson (Jakub Molinski) in branch 'master':
bpo-36625: Remove obsolete comments from docstrings in fractions module (GH-12822)
a9a2880