Add concrete examples to os.path documentation
Open
Nobody has claimed this yet.
docs
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 558
Description
| BPO | 41946 |
|---|---|
| Nosy | @rhettinger, @theacodes, @akulakov, @jdevries3133 |
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-10-05.16:06:07.462>
labels = ['type-feature', 'docs']
title = 'Add concrete examples to os.path documentation'
updated_at = <Date 2021-08-05.19:37:30.280>
user = 'https://github.com/theacodes'
bugs.python.org fields:
activity = <Date 2021-08-05.19:37:30.280>
actor = 'jack__d'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-10-05.16:06:07.462>
creator = 'theacodes'
dependencies = []
files = []
hgrepos = []
issue_num = 41946
keywords = []
message_count = 5.0
messages = ['378043', '398912', '399025', '399027', '399032']
nosy_count = 5.0
nosy_names = ['rhettinger', 'docs@python', 'theacodes', 'andrei.avk', 'jack__d']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue41946'
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
Start by reading the os.path documentation and the discussion linked to BPO issue 41946. Add concrete examples for the documented os.path functionality, with completion shown by the examples appearing clearly in the relevant documentation and passing documentation checks.
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
- Mostly clear
- Newbie friendliness
- 38/100