Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add protocol description to the Traversable and TraversableResources documentation #89679

Open
FFY00 opened this issue Oct 18, 2021 · 7 comments
Open

Add protocol description to the Traversable and TraversableResources documentation #89679

FFY00 opened this issue Oct 18, 2021 · 7 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@FFY00
Copy link
Member

FFY00 commented Oct 18, 2021

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 = []
    @FFY00 FFY00 added the docs Documentation in the Doc dir label Oct 18, 2021
    @FFY00 FFY00 added the docs Documentation in the Doc dir label Oct 18, 2021
    @jaraco
    Copy link
    Member

    jaraco commented Oct 18, 2021

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

    @FFY00
    Copy link
    Member Author

    FFY00 commented Oct 19, 2021

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

    @jaraco
    Copy link
    Member

    jaraco commented Oct 19, 2021

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

    @FFY00 FFY00 closed this as completed Oct 19, 2021
    @FFY00 FFY00 added the type-feature A feature request or enhancement label Oct 19, 2021
    @FFY00 FFY00 closed this as completed Oct 19, 2021
    @FFY00 FFY00 added the type-feature A feature request or enhancement label Oct 19, 2021
    @jaraco
    Copy link
    Member

    jaraco commented Oct 23, 2021

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

    @miss-islington
    Copy link
    Contributor

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

    @miss-islington
    Copy link
    Contributor

    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
    Copy link
    Contributor

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

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @iritkatriel iritkatriel reopened this Apr 11, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @jaraco @iritkatriel @FFY00 @miss-islington