Add protocol description to the Traversable and TraversableResources documentation

[FFY00]

BPO	45516
Nosy	@jaraco, @miss-islington, @FFY00
PRs	bpo-45516: add protocol description to the Traversable documentation #29039 bpo-45516: use documentation links in TraversableResources' description #29045 bpo-45516: add protocol description to the TraversableResources docum… #29173 bpo-45516: improve TraversableResources's documentation #29174 bpo-45516: fix Traversable.name documentation #29194 [3.9] bpo-45516: add protocol description to the Traversable documentation (GH-29039) #29348 [3.10] bpo-45516: add protocol description to the Traversable documentation (GH-29039) #29349

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2021-10-19.00:53:18.539>
created_at = <Date 2021-10-18.19:07:19.319>
labels = ['type-feature', 'docs']
title = 'Add protocol description to the Traversable and TraversableResources documentation'
updated_at = <Date 2021-10-31.19:27:58.448>
user = 'https://github.com/FFY00'

bugs.python.org fields:

activity = <Date 2021-10-31.19:27:58.448>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-10-19.00:53:18.539>
closer = 'FFY00'
components = ['Documentation']
creation = <Date 2021-10-18.19:07:19.319>
creator = 'FFY00'
dependencies = []
files = []
hgrepos = []
issue_num = 45516
keywords = ['patch']
message_count = 7.0
messages = ['404239', '404254', '404256', '404887', '405405', '405414', '405415']
nosy_count = 4.0
nosy_names = ['jaraco', 'docs@python', 'miss-islington', 'FFY00']
pr_nums = ['29039', '29045', '29173', '29174', '29194', '29348', '29349']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45516'
versions = []

[jaraco]

New changeset 4d03de3 by Filipe Laíns in branch 'main':
bpo-45516: add protocol description to the Traversable documentation (bpo-29039)
4d03de3

[FFY00]

Actually, since TraversableResources is simply implementing ResourceReader, the protocol is documented. We could reference ResourceReader in the docstring though.

[jaraco]

New changeset c029567 by Filipe Laíns in branch 'main':
bpo-45516: use documentation links in TraversableResources' description (GH-29045)
c029567

[jaraco]

New changeset 8ce20bb by Filipe Laíns in branch 'main':
bpo-45516: add protocol description to the TraversableResources documentation (bpo-29173)
8ce20bb

[miss-islington]

New changeset bc8fd7c by Filipe Laíns in branch 'main':
bpo-45516: fix Traversable.name documentation (GH-29194)
bc8fd7c

[miss-islington]

New changeset 89b1237 by Miss Islington (bot) in branch '3.10':
bpo-45516: add protocol description to the Traversable documentation (GH-29039)
89b1237

[miss-islington]

New changeset b04b307 by Miss Islington (bot) in branch '3.9':
bpo-45516: add protocol description to the Traversable documentation (GH-29039)
b04b307