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

Documentation #13

Open
Kitt3120 opened this issue Nov 14, 2023 · 0 comments
Open

Documentation #13

Kitt3120 opened this issue Nov 14, 2023 · 0 comments
Assignees
@Kitt3120
Labels
documentation Improvements or additions to documentation

Comments

@Kitt3120
Copy link
Owner

Kitt3120 commented Nov 14, 2023 •
edited
Loading

Currently, Cargo can only generate the project's structure and functions/methods as documentation. Comments should be added to describe each function/method, so Cargo can generate better documentation.

Also see: https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#making-useful-documentation-comments
@Kitt3120 Kitt3120 added the documentation Improvements or additions to documentation label Nov 14, 2023
@Kitt3120 Kitt3120 self-assigned this Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kitt3120 Kitt3120

Labels
documentation Improvements or additions to documentation
Projects
rusty_chat project
Status: ❗ Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Kitt3120