Basic documentation for rules #393
Closed
Conversation
This file contains hidden or 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
|
Thank you for the effort here! However, we've decided to go with the approach merged in #615, which generates the documentation automatically as part of |
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.
Hi there!
Couldn't quite finish this today, but as will go on vacation wanted to open a PR anyway.
This adds some very basic documentation on the rules and closes #382
The rules that are missing detailed documentation were either very clear from naming (for example
NeverForceUnwrapor I had trouble testing myself (such asUseWhereClausesInForLoops).If there are any questions or improvements, please let me know. I won't be checking in for the next 1-2 weeks, but after that will look into comments if there are any.
Cheers!