Viewing pydoc API documentation
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 42710 |
|---|
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 2020-12-22.04:26:31.062>
labels = ['docs']
title = 'Viewing pydoc API documentation'
updated_at = <Date 2020-12-22.04:26:31.062>
user = 'https://bugs.python.org/FarisChugthai'
bugs.python.org fields:
activity = <Date 2020-12-22.04:26:31.062>
actor = 'Faris Chugthai'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-12-22.04:26:31.062>
creator = 'Faris Chugthai'
dependencies = []
files = []
hgrepos = []
issue_num = 42710
keywords = []
message_count = 1.0
messages = ['383570']
nosy_count = 2.0
nosy_names = ['docs@python', 'Faris Chugthai']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue42710'
versions = []
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
The issue contains only the title and migrated tracker metadata; no file, test, or entry point is named. Start by clarifying what change is wanted for viewing pydoc API documentation and which documentation or pydoc behavior is in scope. Done should be defined as an agreed requirement and a corresponding documentation change or verified behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100