poor documentation for .startswith, .endswith
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 37490 |
|---|---|
| Nosy | @stevendaprano, @aldwinaldwin |
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-07-03.05:01:35.684>
labels = ['docs']
title = 'poor documentation for .startswith, .endswith'
updated_at = <Date 2020-09-19.18:03:39.370>
user = 'https://bugs.python.org/vpython'
bugs.python.org fields:
activity = <Date 2020-09-19.18:03:39.370>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-07-03.05:01:35.684>
creator = 'v+python'
dependencies = []
files = []
hgrepos = []
issue_num = 37490
keywords = []
message_count = 9.0
messages = ['347179', '347180', '347185', '347187', '347188', '347189', '347194', '347195', '347212']
nosy_count = 5.0
nosy_names = ['holdenweb', 'v+python', 'steven.daprano', 'docs@python', 'aldwinaldwin']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue37490'
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 Python documentation entries for str.startswith() and str.endswith(), then compare their wording and examples with the intended behavior. Clarify what information is missing or misleading, update the relevant documentation, and verify that both entries explain their usage consistently.
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
- 30/100