Improved docs #273
Merged
Improved docs #273
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
dosisod
requested changes
Aug 1, 2023
There was a problem hiding this comment.
Thank you @trag1c for opening this PR!
One thing that I haven't documented yet is that the docs/checks.md file is auto-generated from the docstrings for each of the checks. For instance, to change the docs for FURB100, go to the refurb/checks/pathlib/with_suffix.py file and change the docstring there, then run make docs which will build the docs/checks.md file. I will go ahead and document this later tonight.
Other than that everything looks good!
dosisod
reviewed
Aug 3, 2023
dosisod
requested changes
Aug 3, 2023
dosisod
approved these changes
Aug 3, 2023
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.
No description provided.