Insufficient description of relative imports in docs.python.org
Open
Nobody has claimed this yet.
docs
type-bug
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 38509 |
|---|---|
| Nosy | @anirudnits |
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-10-17.16:38:32.264>
labels = ['type-bug', 'docs']
title = 'Insufficient description of relative imports in docs.python.org'
updated_at = <Date 2019-10-17.16:38:32.264>
user = 'https://github.com/anirudnits'
bugs.python.org fields:
activity = <Date 2019-10-17.16:38:32.264>
actor = 'Aniruddha Bhattacharjee'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-10-17.16:38:32.264>
creator = 'Aniruddha Bhattacharjee'
dependencies = []
files = []
hgrepos = []
issue_num = 38509
keywords = []
message_count = 1.0
messages = ['354851']
nosy_count = 2.0
nosy_names = ['docs@python', 'Aniruddha Bhattacharjee']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38509'
versions = ['Python 3.6']
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
Start at the relative-import documentation on docs.python.org and review the context of BPO issue 38509. Identify what explanation is missing for newcomers and update the relevant documentation so relative imports are described sufficiently and accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100