[New-bugs-announce] [issue10289] Document magic methods called by built-in functions

[Éric Araujo]

New submission from Éric Araujo <merwok at netwok.org>:

At the top of Doc/library/functions.rst, which documents built-in functions like abs, getattr or hash, a comment reads “document all delegations to __special__ methods”.

Some functions are already good: enumerate for instance does link to the definition of iterator and hints about the __next__ method, format points to __format__, etc.  They can serve as example for how to add links (in plain text and in the global index).

----------
assignee: docs at python
components: Documentation
messages: 120189
nosy: docs at python, eric.araujo
priority: normal
severity: normal
stage: needs patch
status: open
title: Document magic methods called by built-in functions
versions: Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue10289>
_______________________________________