Skip to main content

discover_examples

Function discover_examples 

Source
pub fn discover_examples(
    share_root: &Path,
) -> Result<Vec<ExampleRecord>, ExamplesDiscoverError>
Expand description

Discover bundled examples under {share_root}/examples/.

Each README.md with mandatory name and description frontmatter becomes one record. READMEs may live in an example folder or in the examples base folder when one README documents multiple related examples.

§Errors

Returns ExamplesDiscoverError when the examples directory cannot be read.