Doc: Adding Documentation to the Project #221
Conversation
Sunnickel
changed the title
|
You can add a hyphen in front of [] so GitHub recognizes the list. Also, skip world_gen. None of that code will be present once terrrain-gen branch is merged (which may take a while, but still) |
Oh yeah, thanks! |
plugins not implemented yet.
| use super::PrimitiveArgument; | ||
|
|
||
| impl CommandArgument for bool { | ||
| /// Parses the boolean string to a value for the server. |
There was a problem hiding this comment.
there's no need to document trait methods on implementing structs, the trait methods have documentation
| let current_node = &self.nodes[node_idx as usize]; | ||
| let input_words: Vec<&str> = remaining_input.split_whitespace().collect(); | ||
|
|
||
| // once the input is empty and the currently selected node is executable, we've found it. |
There was a problem hiding this comment.
what's with removing these?
|
I'm kinda abandoning this currently, I will probably pick this up at unknown point in the future. If someone wants to just pick it up and work on it further, I'm very happy to add you as a contributor on my fork and accept contributions. Just write me on discord |
4 participants
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.