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

Documentation #6

Open
emesare opened this issue Apr 1, 2024 · 2 comments
Open

Documentation #6

emesare opened this issue Apr 1, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@emesare
Copy link
Owner

emesare commented Apr 1, 2024

We really need to document the public API, this should be done before #1.

@emesare emesare added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Apr 1, 2024
@emesare emesare self-assigned this Apr 1, 2024
@kanz-1805
Copy link

Hi @emesare into the API documentation requirement. If it is REST API, I'd love to help you with the documentation. Thanks!

@emesare
Copy link
Owner Author

emesare commented May 12, 2024

Hi @emesare into the API documentation requirement. If it is REST API, I'd love to help you with the documentation. Thanks!

It is not, I am referring to the inline documentation that exists inside the rust code. rust crates documentation (i.e. docs.rs) is generated using this and that is why it should be added before we publish the crate

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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants