Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Sep 20, 2023
1 parent 675c171 commit dedeb57
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ python3 -m http.server 9000 --directory public

## Test the docs locally

To ensure all python snippets are properly formatted before creating a PR, install [flake8-markdown](https://github.com/johnfraney/flake8-markdown) and add the following like to `.git/hooks/pre-commit`:
To ensure all python snippets are properly formatted before creating a commit, install [flake8-markdown](https://github.com/johnfraney/flake8-markdown) and add the following like to `.git/hooks/pre-commit`:

```sh
flake8-markdown "docs/**/*.md"
flake8-markdown $(git diff --diff-filter=d --name-only HEAD | grep '\.md$')
```

To ensure your markdown is properly formatted, run `make markdowntest`.
Expand Down

0 comments on commit dedeb57

Please sign in to comment.