docs: secureli 540 update documentation #560
Merged
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.
secureli-540
This ticket was about a problem with configuring the pre-commit library. I determined that the issue was due to misconfiguration by the user, and the solution we settled on was to add documentation about how to specify args in the pre-commit library's configuration file.
Additionally, I updated headings throughout the file. Previously there were multiple H1s, and the License section was nested underneath the Configuration section. I've updated it so that there is only a single H1 heading--the title of the document--and the License section is now a sibling of configuration instead of a child.
Changes
Testing
Clean Code Checklist