[docs] [issue19069] Built-in float docstrings are not PEP-8 compatible

Marco Buttu report at bugs.python.org
Sun Sep 22 09:18:11 CEST 2013

New submission from Marco Buttu:

As reported in the title: 

>>> float.as_integer_ratio.__doc__.splitlines()[2]
'Returns a pair of integers, whose ratio is exactly equal to the original'
>>> float.as_integer_ratio.__doc__.splitlines()[4]
'Raises OverflowError on infinities and a ValueError on NaNs.'
>>> float.conjugate.__doc__
'Returns self, the complex conjugate of any float.'
>>> float.is_integer.__doc__
'Returns True if the float is an integer.'
>>> float.__setformat__.__doc__.splitlines()[-2]
'Overrides the automatic determination of C-level floating point type.'

They should have been 'Return...', 'Raise...' and 'Override...'
Patch is attached

assignee: docs at python
components: Documentation
files: floatobject.patch
keywords: patch
messages: 198246
nosy: docs at python, marco.buttu
priority: normal
severity: normal
status: open
title: Built-in float docstrings are not PEP-8 compatible
type: enhancement
versions: Python 3.1, Python 3.2, Python 3.3
Added file: http://bugs.python.org/file31840/floatobject.patch

Python tracker <report at bugs.python.org>

More information about the docs mailing list