Skip to content

Examples in docs #1

@trissylegs

Description

@trissylegs

The docs don't have any examples.

Originally I didn't do this because there's a lot of set up. But in @killercup's talk at Rust Kyiv. I've learn't that you do something like this:

/// Version get's the version info.
///```
///     # include!("src/rustdoc_helper.rs")
///     let version = Device::first_card()?.get_version();
///```

Due to the manipulation of actual system hardware, it's probably not ideal to run all doc tests.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions