TODO: docs

[mikeshardmind]

[mikeshardmind]

Partially resolved by d9ca435

Taking time to consider more here including examples and published rendered documentation before considering this done.

[mikeshardmind]

concrete thing that could use additional clarity: the expected use of cache_transformer functions, possibly also an API break here worth considering.

[mikeshardmind]

This is now the top priority for this project between now and python 3.14's stable release.

Things to document immediately

• Stability policy
• All public functions and classes

Things to document after

• How to get the most out of this when mixing various concurrency methods
• A "Hitchiker's guide to python concurrency" to ensure people understand important topics like maintaining backpressure in externally exposed services.
• A full rebuttal to "What color is your function", as it keeps coming up with people pushing against async.

[mikeshardmind]

Symbols without documentation:
Functions without docstring: 1
Functions without default param: 0
Classes without docstring: 2

Needs some prose + rendering & hosting, but nearly ready for stable release at this point