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.

Sign up for GitHub

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

Jump to bottom

docs: Improve Crate Documentation #205

Open
carlaKC opened this issue Nov 20, 2024 · 0 comments
Open

docs: Improve Crate Documentation #205

carlaKC opened this issue Nov 20, 2024 · 0 comments
Labels
feature New feature or request

Comments

@carlaKC
Copy link
Contributor

carlaKC commented Nov 20, 2024

simln-lib is a crate now 🎉
But it's quite an unfriendly one (not- 🎉 ) becuase we're missing a few docs.

There are a few low-hanging fruit that we could address to fix this up.

Add a Readme

Screenshot 2024-11-20 at 13 21 04

Better documentation for exported structs / enums

Screenshot 2024-11-20 at 13 21 15
@carlaKC carlaKC added the feature New feature or request label Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@carlaKC