Skip to content

Commit

Permalink
docs: Fix snippet to find invalid section syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Sep 11, 2023
1 parent 0d0fe65 commit d670ec3
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions docs/docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,7 @@ Note:
Find out possibly invalid section syntax by grepping for "reasons" in Griffe debug logs:

```bash
griffe dump -Ldebug -o/dev/null \
-fdgoogle -D '{"strict_sections": true}' \
your_package 2>&1 | grep reasons
griffe dump -Ldebug -o/dev/null -fdgoogle your_package 2>&1 | grep reasons
```

Some sections support documenting multiple items (attributes, parameters, etc.).
Expand Down

0 comments on commit d670ec3

Please sign in to comment.