python-trio / python-trio/trio
Some doc todos
Open
@njsmith is already working on this.
Since Jul 4, 2017.
docs
missing piece
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 431
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
Notes to self, stuff I want to add soon-ish:
- add some narrative docs about async filesystem IO
in particular mentioning thread-safety issues and why/when this is useful
add tables showing methods:
- stream ABCs
- async filesystem methods
tutorial:
- rework intro a bit to say that trio = regular synchronous python + 3 things: async functions, nurseries (and MultiError), and cancellation
- and maybe also frame it around the 3 pillars of trio's design philosophy (no implicit concurrency, no lost exceptions, expose checkpoints)
- include a "where to ask questions" note
- talk about MultiError
- talk about cancellation
- review how these all fit together
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.
Assessment
This issue has not been assessed yet.