python / python/cpython

Search is not beginner friendly

Open
#87,780 8 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

3.10 3.11 3.9 (EOL) docs type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 43614
Nosy @rhettinger, @Rosuav, @serhiy-storchaka, @ammaraskar, @TonyFlury, @kamilturek
PRs
  • python/cpython#25045
  • 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 2021-03-24.11:12:48.698>
    labels = ['type-feature', '3.8', '3.9', '3.10', 'docs']
    title = 'Search is not beginner friendly'
    updated_at = <Date 2021-04-29.16:24:39.303>
    user = 'https://github.com/TonyFlury'
    

    bugs.python.org fields:

    activity = <Date 2021-04-29.16:24:39.303>
    actor = 'ammar2'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2021-03-24.11:12:48.698>
    creator = 'anthony-flury'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 43614
    keywords = ['patch']
    message_count = 4.0
    messages = ['389442', '389473', '389627', '392328']
    nosy_count = 7.0
    nosy_names = ['rhettinger', 'docs@python', 'Rosuav', 'serhiy.storchaka', 'ammar2', 'anthony-flury', 'kamilturek']
    pr_nums = ['25045']
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue43614'
    versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']
    

    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 reviewing the original BPO issue 43614 and the existing PR #25045; no source files or tests are named here. Use those materials to determine the intended documentation change, and consider it done when the proposed search experience is made more beginner-friendly.

    Written by the indexing model from the issue text.

    Assessment

    Tech stack
    python
    Domain
    documentation
    Issue type
    Feature
    Difficulty
    3/5
    Estimated time
    1-2 days
    Activity status
    Stale
    Clarity
    Needs clarification
    Newbie friendliness
    15/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.