There are inconsitencies in the treatment of True, False, None, and __debug__ keywords in the docs
Open
Nobody has claimed this yet.
3.7 (EOL)
3.8 (EOL)
docs
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 34464 |
|---|---|
| Nosy | @bitdancer, @serhiy-storchaka, @matrixise, @jfine2358 |
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 2018-08-22.19:08:50.656>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'There are inconsitencies in the treatment of True, False, None, and __debug__ keywords in the docs'
updated_at = <Date 2019-03-15.21:08:19.424>
user = 'https://github.com/jfine2358'
bugs.python.org fields:
activity = <Date 2019-03-15.21:08:19.424>
actor = 'matrixise'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-08-22.19:08:50.656>
creator = 'jfine2358'
dependencies = []
files = []
hgrepos = []
issue_num = 34464
keywords = []
message_count = 6.0
messages = ['323904', '323905', '323907', '336091', '336099', '338035']
nosy_count = 5.0
nosy_names = ['r.david.murray', 'docs@python', 'serhiy.storchaka', 'matrixise', 'jfine2358']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue34464'
versions = ['Python 3.7', 'Python 3.8']
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or documentation entry points are named. Start by locating the documentation sections covering True, False, None, and debug, then compare their wording and treatment. Done means the inconsistencies are identified and the relevant documentation is made consistent across the affected Python versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100