[issue14393] Incorporate Guide to Magic Methods?

New submission from Dirkjan Ochtman <dirkjan@ochtman.nl>: Should we perhaps ask if we can include https://github.com/RafeKettler/magicmethods in the official docs? It seems nice (and now ranks higher on Google than the official docs...). ---------- assignee: docs@python components: Documentation messages: 156639 nosy: djc, docs@python priority: normal severity: normal status: open title: Incorporate Guide to Magic Methods? _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14393> _______________________________________

Benjamin Peterson <benjamin@python.org> added the comment: Someone would have to 1) determine if this a good idea 2) ask the author 3) actually perform the integration (that is determine how this would replace/complement things in reference/*). ---------- nosy: +benjamin.peterson _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14393> _______________________________________

Terry J. Reedy <tjreedy@udel.edu> added the comment: If one searches for the informal name 'Python magic methods', RafeKettler's doc and 3. Data model — Python v2.7.2 documentation come in 1,2. Given that the latter does not even contain the word 'magic', that means that is actually ranks higher in some real sense. Suggestion: we should do a bit of SEO and add the informal name to that page (and 3.4). Then either might come in first for such inquiries. If one searches for the official name 'Python special methods', then our Chapter 3 comes in first and RafeK's doc 9th. The 2.5.2 version of 3.4 Special method names comes in second. This points to a second problem with google rank: we have several versions of the docs indexed, so links to our docs are scattered among them, and none rank as high as they really should. I glanced at the git doc and it seems to largely duplicate the info in the docs already. So it should not be just 'incorporated'. Dirkjan: if you have any specific suggestions for doc improvement, regardless of inspiration, please give them. If not, I think this issue should be closed. ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14393> _______________________________________

Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14393> _______________________________________

Changes by Jesús Cea Avión <jcea@jcea.es>: ---------- nosy: +jcea _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14393> _______________________________________

Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- type: -> enhancement versions: +Python 2.7, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14393> _______________________________________

Raymond Hettinger added the comment: Much of that article is taken directly from the official docs and adds very little in the way of explanation. I think we need our own write-up with better explanations and examples. ---------- nosy: +rhettinger _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14393> _______________________________________
participants (6)
-
Benjamin Peterson
-
Dirkjan Ochtman
-
Ezio Melotti
-
Jesús Cea Avión
-
Raymond Hettinger
-
Terry J. Reedy