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 : Add in code documentation #49

Closed
wants to merge 1 commit into from
Closed

docs : Add in code documentation #49

wants to merge 1 commit into from

Conversation

Razaloc
Copy link
Contributor

@Razaloc Razaloc commented Nov 21, 2022 •
edited
Loading

Add documentiation as special comments to be formatted with rustdoc.

Closes: #48

Signed-off-by: Rafael Garcia Ruiz [email protected]

@Razaloc Razaloc force-pushed the wip/rafaelgarrui/docs branch 2 times, most recently from 1b0ed30 to 2e4ef77 Compare November 21, 2022 18:33
@Razaloc
Copy link
Contributor Author

Razaloc commented Nov 21, 2022

#![warn(missing_docs)] raises a warning in compiling time if the expected docs are not satisfied. That's why I've added description to all the required parts of the code that asked for it.

obbardc
obbardc suggested changes Nov 22, 2022
View reviewed changes
Copy link
Contributor

@obbardc obbardc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could use a spelling & grammar check :-)

@Razaloc Razaloc force-pushed the wip/rafaelgarrui/docs branch from 2e4ef77 to 5bb1e0d Compare November 22, 2022 12:01
@Razaloc Razaloc marked this pull request as ready for review November 22, 2022 17:33
@Razaloc Razaloc force-pushed the wip/rafaelgarrui/docs branch 4 times, most recently from 3b45139 to 5bb1e0d Compare November 25, 2022 15:52
@Razaloc Razaloc changed the title Add in code documentation docs : Add in code documentation Nov 25, 2022
@Razaloc
Copy link
Contributor Author

Razaloc commented Nov 25, 2022

Indeed we don't need the #![warn(missing_docs)] tag.

@Razaloc Razaloc force-pushed the wip/rafaelgarrui/docs branch 3 times, most recently from baa1e86 to a5260fb Compare December 1, 2022 10:35
@Razaloc Razaloc force-pushed the wip/rafaelgarrui/docs branch 2 times, most recently from bc03625 to 4ae95f2 Compare December 16, 2022 21:22
@Razaloc Razaloc force-pushed the wip/rafaelgarrui/docs branch from 4ae95f2 to 35fa030 Compare January 13, 2023 08:56
@Razaloc
Add in code documentation
5fd971c 
Add documentiation as special comments to be formatted by rustdoc.
Also when releasing the crates in crates.io the documentation will be
auto-generated and stored at docs.rs

Signed-off-by: Rafael Garcia Ruiz <[email protected]>
@Razaloc Razaloc force-pushed the wip/rafaelgarrui/docs branch from 35fa030 to 5fd971c Compare January 19, 2023 12:20
@obbardc obbardc closed this Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@obbardc obbardc obbardc requested changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Generate documentation
2 participants
@Razaloc @obbardc