python / python/cpython

In xml.etree.ElementTree docs there are many absent Element class links

Open
#72,421 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.7 (EOL) docs stdlib topic-XML type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 28234
Nosy @scoder, @py-user, @vadmium, @serhiy-storchaka
PRs
  • python/cpython#9766
  • Files
  • element-link.diff: Add Element links
  • 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 = None
    created_at = <Date 2016-09-21.10:27:48.726>
    labels = ['expert-XML', '3.7', 'type-bug', 'library', 'docs']
    title = 'In xml.etree.ElementTree docs there are many absent Element class links'
    updated_at = <Date 2018-10-09.14:05:31.849>
    user = 'https://github.com/py-user'
    

    bugs.python.org fields:

    activity = <Date 2018-10-09.14:05:31.849>
    actor = 'serhiy.storchaka'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation', 'Library (Lib)', 'XML']
    creation = <Date 2016-09-21.10:27:48.726>
    creator = 'py.user'
    dependencies = []
    files = ['44775']
    hgrepos = []
    issue_num = 28234
    keywords = ['patch']
    message_count = 8.0
    messages = ['277121', '277187', '277194', '277197', '277209', '277211', '277219', '277255']
    nosy_count = 6.0
    nosy_names = ['scoder', 'eli.bendersky', 'docs@python', 'py.user', 'martin.panter', 'serhiy.storchaka']
    pr_nums = ['9766']
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue28234'
    versions = ['Python 2.7', 'Python 3.5', 'Python 3.6', 'Python 3.7']
    

    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

    Start with the xml.etree.ElementTree documentation and compare its current Element references with the element-link.diff file attached to the issue. Review the existing PR python/cpython#9766 before making changes. Done means the relevant Element class references in the documentation resolve to links.

    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
    Clearly specified
    Newbie friendliness
    35/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.