Skip to content

Set up API documentation from source code #82

@mondeja

Description

@mondeja

Currently the API is documented in the README but is not complete. This is not maintainable because is not generated from source code.

Instead, we should document it using docstrings in functions and arguments and provide a nice introduction in https://docs.rs/leptos_hotkeys/0.2.0-alpha.1 taken from part of the README using cargo-readme or something like that. Rust developers are more accustomed to reading the documentation on docs.rs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions