[issue34015] doc Add link to Descriptor HowTo Guide in Data Model
New submission from Andrés Delfino <adelfino@gmail.com>: IMHO, it would be useful to make the Descriptor HowTo Guide more discoverable. As far as I can see, we are not linking to it from anywhere except the HOWTO index. Section 3.3.2.2., "Implementing Descriptors", in "Data Model" seems to be the most appropriate place. ---------- assignee: docs@python components: Documentation messages: 320821 nosy: adelfino, docs@python priority: normal severity: normal status: open title: doc Add link to Descriptor HowTo Guide in Data Model type: enhancement versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34015> _______________________________________
Change by Andrés Delfino <adelfino@gmail.com>: ---------- keywords: +patch pull_requests: +7647 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34015> _______________________________________
INADA Naoki <songofacandy@gmail.com> added the comment: I think "See also" is better than sidebar. Many other sections in data-model chapter have it. ---------- nosy: +inada.naoki _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34015> _______________________________________
Andrés Delfino <adelfino@gmail.com> added the comment: ok :) I have just updated the PR following your comment. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34015> _______________________________________
Raymond Hettinger <raymond.hettinger@gmail.com> added the comment: I don't want to do this. The docs are the authoritative source and the how-to is a secondary source that is primarily about how particular descriptors are implemented. ---------- nosy: +rhettinger resolution: -> rejected stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34015> _______________________________________
participants (3)
-
Andrés Delfino -
INADA Naoki
-
Raymond Hettinger