(docs): run doctoc on pre-commit#399
Merged
Merged
Conversation
- and install it as a devDep - doctoc is used in the README ToC and listed in comment, but wasn't a devDep or used in any internal scripts
Collaborator
|
how bout doing this via github action? |
Collaborator
Author
|
ah so looks like this is a known issue of But, in general, re: GitHub Action -- a GH Action wouldn't prevent errors like those in #307 from getting in, it would just fix them with an additional commit after; better to nip it in the bud beforehand imo. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
and install it as a devDep
doctoc is used in the README ToC and listed in comment, but wasn't
a devDep or used in any internal scripts
Follow-up to #397 . Please merge after that one and after #398 , which I split out from this PR.
The big thing that's not so helpful about running
doctocon pre-commit as that it won't abort the commit if changes were made. It just adds new changes, but those haven't been staged yet so won't be included in the commit (unless you amend them in). Not sure what a better method may be that isn't overly complex 😕