[docs] [issue12965] longobject: documentation improvements

Stefan Krah report at bugs.python.org
Mon Sep 12 18:57:50 CEST 2011

New submission from Stefan Krah <stefan-usenet at bytereef.org>:

I think the integer objects documentation could be clearer on a
couple of points:

  - Despite being listed under "Concrete Objects Layer", some
    functions implicitly accept anything with an __int__()
    method. Currently only the PyLong_AsLong() documentation
    states this explicitly.

    The patch clearly distinguishes between functions that
    duck type and functions that don't. 

  - The patch replaces "is greater than *_MAX" instances with
    "out of bounds" to include the other error condition
    "is less than *_MIN".

Additionally, the patch fixes comments in longobject.c that
don't state the duck typing behavior.

assignee: docs at python
components: Documentation
files: longobject-doc.diff
keywords: patch
messages: 143922
nosy: docs at python, mark.dickinson, skrah
priority: normal
severity: normal
stage: patch review
status: open
title: longobject: documentation improvements
type: feature request
versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3
Added file: http://bugs.python.org/file23133/longobject-doc.diff

Python tracker <report at bugs.python.org>

More information about the docs mailing list