python-trio / python-trio/trio
rename TASK_STATUS_IGNORED to TASK_STATUS_STUB
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 431
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
The name TASK_STATUS_IGNORED is disconcerting to users of an async API (who may not be aware of the intricacies of start() vs. start_soon()) because it sounds like if they leave that default in place, something significant might get ignored. It's important to find a good name since this constant will appear in virtually all API's using Trio, and we can't rely on every author to document its meaning in every function signature it appears.
TASK_STATUS_STUB would be more descriptive for both API authors and users.
User: : "it's a harmless default which I don't necessarily need to learn about yet"
Author: "it's a dummy object which will ignore calls to started() and custom/future extensions"
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
Search the repository for TASK_STATUS_IGNORED and inspect all references and related tests before changing the public name. Done means the constant and its usages consistently use TASK_STATUS_STUB, with the test suite still passing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100