embassy

embassy copied to clipboard

This includes more examples for stuff such as Portal, Signal, and other built-in primitives like InterruptFuture.

Mar 07 '21 12:03 eupn

Started on this with the wiki. It's not great for now, but can allow more contributions of quick information, which we can eventually use to create better documentation.

Mar 21 '21 18:03 xoviat

Started working on some in-source documentation such that cargo +nightly doc produces meaningful output.

Mar 22 '21 00:03 theunkn0wn1

What sort of documentation should we aspire to here? Perhaps we could enhance the description for clarity.

Oct 05 '21 23:10 huntc

Embassy's public interface must be documented; meaning anything this crate exports that a user may need, should have usable documentation beyond what cargo doc spits out by default. While most things on the public interface have been descriptively named, usage is still quite a confusing aspect.

Optimally, every function should include a description of what its used for, with what other components, and an example of how to use it.

Oct 06 '21 00:10 theunkn0wn1