Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up API documentation from source code #82

Open
mondeja opened this issue Mar 21, 2024 · 1 comment
Open

Set up API documentation from source code #82

mondeja opened this issue Mar 21, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mondeja
Copy link
Collaborator

mondeja commented Mar 21, 2024

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.

@mondeja mondeja added the documentation Improvements or additions to documentation label Mar 21, 2024
@mondeja
Copy link
Collaborator Author

mondeja commented Mar 25, 2024

Seems to me that this is not worth to accomplish for v0.2.0 because the API will change a bit on v0.3.0, so I'm posponing it...

@mondeja mondeja added this to the v0.3.0 milestone Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant