Provide rustdoc examples for all items in the public API

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Unresolved
    • Priority: Unknown
    • None
    • Affects Version/s: None
    • Component/s: Docs
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      According to the Rust API guidelines, all public items should have a rustdoc example "within reason". We should provide such examples to meet this guideline.

      reference: https://rust-lang.github.io/api-guidelines/documentation.html#c-example

            Assignee:
            Unassigned
            Reporter:
            Patrick Freed
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: