search

nuggetInc / nuggetInc.github.io

Personal portfolio generator written in rust
0 stars 1 forks source link

Missing documentation #2

Open nuggetInc opened 1 year ago

nuggetInc commented 1 year ago

Documentation is a necessity for a portfolio project as it better conveys intention to readers.

Adding #![deny(missing_docs)] should ensure documentation gets maintained along the way.

nuggetInc commented 1 year ago

a4809f915074a1fd3500e5dc13a348c1066f4830 partially resolves this issue by documenting the main crates.

Documentation is still minimal and, for now, won't include examples until the API is more stable.

nuggetInc commented 1 year ago

In the future stricter documentation lints should be added, and Intra-doc links should be used. See https://doc.rust-lang.org/rustdoc/lints.html

Rajdeep1311 commented 1 year ago

would like to work on this issue

nuggetInc commented 1 year ago

Sorry for the late response, I wasn't expecting to get any comments on this repository.

As this is my personal portfolio I mostly create these issues to keep track of things I need to do. But contributions are of course very welcome!

The API is currently still undergoing lots of changes so some code might be harder to document than others, feel free to ask any questions if the code is unclear. I'll do my best to notice the comment this time.