withoutboats / romio

asynchronous networking primitives

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation examples styles

withoutboats opened this issue · comments

Proposing the following norms for documentation (which mostly matches what we've done so far):

  1. Methods only include statements, function signatures are hidden.
  2. Type and module level examples include function signatures, but no main function.
  3. Main function in examples, lib.rs, and README.
  4. Nothing is shown as visibly imported unless its used in the visible code.
  5. No ::std visible in docs; if its used in the shown part of the doc, its imported.
commented

These norms sound good to me!

commented

Closed by #37 🎉