Added Configuration Documentation #394
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A few settings are marked as undocumented since I don't feel like I have a good idea of what those options are doing, so I hope you are able to document those.
In general, we might want to spend some time documenting certain methods, as currently nothing is documented, which makes it really hard for new contributors like myself may have a hard time understanding certain pieces of the code.
Adding
///above a method will automatically generate a documentation template, which you only have to fill in. This will extremely help new contributors to understand the structure of the code since when using///it will enable the hover documentation, which you normally get when hovering over a method.///documentation example: