pydoc with -w option does not work for a lot of help topics

Open
#58,885 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the linked pydoc.patch and reproducing the failure with pydoc's -w option for help topics, keywords, and symbols. Done means -w successfully writes documentation for the affected help topics, with the behavior verified against the reported cases.

Written by the indexing model from the issue text.

Description

stdlib
BPO 14680
Nosy @merwok
Files
  • pydoc.patch: -w now works for topics, keywords and symbols
    		•

    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 2012-04-26.22:11:11.515>
labels = ['library']
title = 'pydoc with -w option does not work for a lot of help topics'
updated_at = <Date 2013-10-20.15:56:23.462>
user = 'https://bugs.python.org/gregorhoch'

    bugs.python.org fields:

    activity = <Date 2013-10-20.15:56:23.462>
actor = 'sunfinite'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2012-04-26.22:11:11.515>
creator = 'gregor.hoch'
dependencies = []
files = ['32258']
hgrepos = []
issue_num = 14680
keywords = ['patch']
message_count = 3.0
messages = ['159428', '162569', '200594']
nosy_count = 3.0
nosy_names = ['eric.araujo', 'gregor.hoch', 'sunfinite']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue14680'
versions = ['Python 2.7', 'Python 3.4']

    Dominant language
    Python
    Stars
    77.2k
    Forks
    36k
    Avg merge
    1d 9h
    Merged PRs (30d)
    558

    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.

    More from python/cpython

    All issues in python/cpython

    Similar issues

    More Python issues

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.