python / python/cpython

Add protocol description to the Traversable and TraversableResources documentation

Open
#89,679 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

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:

    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 = []
    

    Contributor guide

    Open the contributing guide

    First steps

    1. Read the whole issue, then the project's contributing guide.
    2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
    3. Fork the repository and make your change on a branch.
    4. Open a pull request that references the issue number.

    Research direction

    The issue requests a protocol description for the Traversable and TraversableResources documentation. It is already marked fixed and closed upstream, with PRs 29039, 29045, 29173, 29174, 29194, 29348, and 29349 listed, so no further work remains for a new contributor.

    Written by the indexing model from the issue text.

    Assessment

    Tech stack
    python
    Domain
    documentation
    Issue type
    Documentation
    Difficulty
    2/5
    Estimated time
    1-3 hours
    Activity status
    Stale
    Clarity
    Mostly clear
    Newbie friendliness
    10/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.