Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 830 Bytes

README.md

File metadata and controls

16 lines (12 loc) · 830 Bytes

Examples

We try to focus our documentation on the four types of documentation. Examples fit into this by providing:

This directory contains the source for the above.

Contributing

New examples should fit within the above structure and support their narrative

  • Add the example to Cargo.toml for any required-features
  • Document how the example works with a .md file which will be verified using trycmd
  • Pull the .rs and .md file into the appropriate module doc comment to be accessible on docs.rs