Add protocol description to the Traversable and TraversableResources documentation

[FFY00]

BPO	45516
Nosy	@jaraco, @miss-islington, @FFY00
PRs	python/cpython#29039 python/cpython#29045 python/cpython#29173 python/cpython#29174 python/cpython#29194 python/cpython#29348 python/cpython#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: ```python assignee = None closed_at = created_at = labels = ['type-feature', 'docs'] title = 'Add protocol description to the Traversable and TraversableResources documentation' updated_at = user = 'https://github.com/FFY00' ``` bugs.python.org fields: ```python activity = actor = 'miss-islington' assignee = 'docs@python' closed = True closed_date = closer = 'FFY00' components = ['Documentation'] creation = 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 4d03de3329ed8daa9c1107b1aedbb0fa280bddb6 by Filipe Laíns in branch 'main': bpo-45516: add protocol description to the Traversable documentation (bpo-29039) https://github.com/python/cpython/commit/4d03de3329ed8daa9c1107b1aedbb0fa280bddb6

[FFY00]

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

[jaraco]

New changeset c0295675305f6896e4ba7496441cc470d7edca89 by Filipe Laíns in branch 'main': bpo-45516: use documentation links in TraversableResources' description (GH-29045) https://github.com/python/cpython/commit/c0295675305f6896e4ba7496441cc470d7edca89

[jaraco]

New changeset 8ce20bbdd6d2b1277a5e74154fcdcef2cb0fee49 by Filipe Laíns in branch 'main': bpo-45516: add protocol description to the TraversableResources documentation (bpo-29173) https://github.com/python/cpython/commit/8ce20bbdd6d2b1277a5e74154fcdcef2cb0fee49

[miss-islington]

New changeset bc8fd7c9c24eb71217ebdb8a12cf38e9dc4215b2 by Filipe Laíns in branch 'main': bpo-45516: fix Traversable.name documentation (GH-29194) https://github.com/python/cpython/commit/bc8fd7c9c24eb71217ebdb8a12cf38e9dc4215b2

[miss-islington]

New changeset 89b1237ffbd2df2721dc4959e3ccb1106f3555b5 by Miss Islington (bot) in branch '3.10': bpo-45516: add protocol description to the Traversable documentation (GH-29039) https://github.com/python/cpython/commit/89b1237ffbd2df2721dc4959e3ccb1106f3555b5

[miss-islington]

New changeset b04b307e0ebad0d9c7cc311fe6018b8d31b2ac8d by Miss Islington (bot) in branch '3.9': bpo-45516: add protocol description to the Traversable documentation (GH-29039) https://github.com/python/cpython/commit/b04b307e0ebad0d9c7cc311fe6018b8d31b2ac8d