python / python/cpython

Misleading documentation for NotImplemented

Open
#83,292 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

BPO 39111
Nosy @stevendaprano, @Murali

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-12-20.16:42:56.150>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Misleading documentation for NotImplemented'
updated_at = <Date 2019-12-28.07:11:38.640>
user = 'https://github.com/Murali'

bugs.python.org fields:

activity = <Date 2019-12-28.07:11:38.640>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-12-20.16:42:56.150>
creator = 'murali'
dependencies = []
files = []
hgrepos = []
issue_num = 39111
keywords = []
message_count = 5.0
messages = ['358719', '358722', '358723', '358726', '358752']
nosy_count = 3.0
nosy_names = ['steven.daprano', 'docs@python', 'murali']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39111'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

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 NotImplemented documentation and the linked BPO issue 39111 to identify which wording is misleading. The issue payload names no file, test, or specific correction, so confirm the intended documentation change before editing and verify that the revised text accurately describes NotImplemented.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.