python-trio / python-trio/trio
StapledStream is a weird name
Open
Nobody has claimed this yet.
potential API breaker
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 432
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
And in my mental picture of two streams, stapling them together chokes both of them off. Why not BidirectionalStream or TwoWayStream? BidiStream is also available, though I wouldn't personally advocate for an abbreviation.
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
Review the existing StapledStream API and its usages before deciding whether a replacement name is warranted. The issue lists BidirectionalStream, TwoWayStream, and BidiStream as alternatives; done would require an agreed name and updating the affected references without breaking users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- networking
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100