classification
Title: doc Add link to Descriptor HowTo Guide in Data Model
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.8, Python 3.7, Python 3.6, Python 2.7
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: docs@python Nosy List: adelfino, docs@python, inada.naoki, rhettinger
Priority: normal Keywords: patch

Created on 2018-07-01 01:34 by adelfino, last changed 2018-07-03 15:15 by rhettinger. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 8037 closed adelfino, 2018-07-01 01:35
Messages (4)
msg320821 - (view) Author: Andrés Delfino (adelfino) * (Python triager) Date: 2018-07-01 01:34
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.
msg320829 - (view) Author: Inada Naoki (inada.naoki) * (Python committer) Date: 2018-07-01 08:03
I think "See also" is better than sidebar.
Many other sections in data-model chapter have it.
msg320835 - (view) Author: Andrés Delfino (adelfino) * (Python triager) Date: 2018-07-01 11:53
ok :) I have just updated the PR following your comment.
msg320986 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2018-07-03 15:15
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.
History
Date User Action Args
2018-07-03 15:15:22rhettingersetstatus: open -> closed

nosy: + rhettinger
messages: + msg320986

resolution: rejected
stage: patch review -> resolved
2018-07-01 11:53:34adelfinosetmessages: + msg320835
2018-07-01 08:03:12inada.naokisetnosy: + inada.naoki
messages: + msg320829
2018-07-01 01:35:37adelfinosetkeywords: + patch
stage: patch review
pull_requests: + pull_request7647
2018-07-01 01:34:21adelfinocreate