classification
Title: Document magic methods called by built-in functions
Type: Stage: needs patch
Components: Documentation Versions: Python 3.2, Python 3.1, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: belopolsky, docs@python, eric.araujo
Priority: normal Keywords:

Created on 2010-11-01 23:54 by eric.araujo, last changed 2010-11-02 00:03 by belopolsky.

Messages (2)
msg120189 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-11-01 23:54
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).
msg120191 - (view) Author: Alexander Belopolsky (belopolsky) * (Python committer) Date: 2010-11-02 00:03
Éric,

I just wanted to link to a related discussion we had under issue 8983.  See msg107689.
History
Date User Action Args
2010-11-02 00:03:09belopolskysetnosy: + belopolsky
messages: + msg120191
2010-11-01 23:54:55eric.araujocreate