Doc: Adding Documentation to the Project #221
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm Updating / Adding in-code documentation for rust in the whole Project (except for tests).
Description
Where ever possible, I'll add documentation in rustdoc style.
Motivation and Context
Boredom
How has this been tested?
How do I test documentation? Please just say if its written good, understandable and how it can be improved or replaced.
(fmt, audit and clippy will be run when everything is done, since this is still a draft.)
Types of changes
Checklist:
Since nothing is changed in code, I changed the checklist to missing packages.