"pydoc -w" causes "no Python documentation found" error when the path is not current directory

Open
#56,040 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the pydoc command and the attached pydoc-27-syspath.diff patch, then reproduce the error when the documented path is outside the current directory. Compare the behavior with the one-line fix and verify that pydoc -w no longer reports “no Python documentation found” for that path.

Written by the indexing model from the issue text.

Description

3.10 3.11 3.9 (EOL) stdlib type-bug
BPO 11831
Nosy @merwok, @iritkatriel
Files
  • pydoc-27-syspath.diff: One line fix for "no Python documentation found" error.
    		•

    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 2011-04-12.00:42:44.568>
labels = ['type-bug', 'library', '3.9', '3.10', '3.11']
title = '"pydoc -w" causes "no Python documentation found" error when the path is not current directory'
updated_at = <Date 2022-01-25.14:30:12.425>
user = 'https://bugs.python.org/susam'

    bugs.python.org fields:

    activity = <Date 2022-01-25.14:30:12.425>
actor = 'iritkatriel'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2011-04-12.00:42:44.568>
creator = 'susam'
dependencies = []
files = ['21624']
hgrepos = []
issue_num = 11831
keywords = ['patch']
message_count = 4.0
messages = ['133557', '133558', '379327', '411595']
nosy_count = 4.0
nosy_names = ['ron_adam', 'eric.araujo', 'susam', 'iritkatriel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue11831'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

    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.