Skip to content

Commit

Permalink
address review
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 committed Dec 12, 2023
1 parent a67bf37 commit c767ca6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ testing the change.
## Writing Documents

Write documents using
[reStructuredText](http://docutils.sourceforge.net/rst.html), following
[GitHub Flavored Markdown](https://github.github.com/gfm/), following
the [MongoDB Documentation Style
Guidelines](https://www.mongodb.com/docs/meta/style-guide/).

Expand All @@ -113,10 +113,10 @@ pre-commit install

To run `pre-commit` manually, run `pre-commit run --all-files`.

To run a manual hook like `rstcheck` manually, run:
To run a manual hook like `shellcheck` manually, run:

```bash
pre-commit run --all-files --hook-stage manual rstcheck
pre-commit run --all-files --hook-stage manual shellcheck
```

## Prose test numbering
Expand All @@ -127,7 +127,7 @@ may refer to existing tests by number.

Outdated tests must not be removed completely, but may be marked as such
(e.g. by striking through or replacing the entire test with a note (e.g.
**Removed**).
*Removed*).

## Building Documents

Expand Down

0 comments on commit c767ca6

Please sign in to comment.