python / python/cpython

Enhancement to pydoc for Python 3.6 to allow full backgrounding as a server

Open
#82,402 1 comment 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 38221
Files
  • pydoc3.diff: Unified diff of enhancement against /usr/lib/python3.6/pydoc.py
  • 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 2019-09-19.01:53:04.702>
    labels = ['type-feature', 'docs']
    title = 'Enhancement to pydoc for Python 3.6 to allow full backgrounding as a server'
    updated_at = <Date 2019-09-19.01:53:04.702>
    user = 'https://bugs.python.org/fmouse'
    

    bugs.python.org fields:

    activity = <Date 2019-09-19.01:53:04.702>
    actor = 'fmouse'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2019-09-19.01:53:04.702>
    creator = 'fmouse'
    dependencies = []
    files = ['48613']
    hgrepos = []
    issue_num = 38221
    keywords = ['patch']
    message_count = 1.0
    messages = ['352766']
    nosy_count = 2.0
    nosy_names = ['docs@python', 'fmouse']
    pr_nums = []
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue38221'
    versions = ['Python 3.6']
    

    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 by reading the linked pydoc3.diff and the referenced /usr/lib/python3.6/pydoc.py, then locate the corresponding pydoc implementation in the current CPython tree. Check how pydoc is invoked as a server and compare the proposed backgrounding behavior with current command-line behavior. Done means pydoc can run fully in the background as a server, with tests or documented validation for that behavior.

    Written by the indexing model from the issue text.

    Assessment

    Tech stack
    python
    Domain
    cli, documentation
    Issue type
    Feature
    Difficulty
    3/5
    Estimated time
    1-2 days
    Activity status
    Stale
    Clarity
    Mostly clear
    Newbie friendliness
    30/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.