Skip to content

Commit

Permalink
docs: add "sphinx" as an allowed style
Browse files Browse the repository at this point in the history
  • Loading branch information
Amar1729 committed Jul 21, 2024
1 parent 94efc5f commit 2c2fe09
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/config_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ _pydoclint_ within _flake8_, you can use _flake8_'s

## 3. `--style`

Which style of docstring is your code base using. Right now there are two
available choices: `numpy` and `google`. The default value is `numpy`.
Which style of docstring is your code base using. Right now there are three
available choices: `numpy`, `google`, and `sphinx`. The default value is
`numpy`.

```
pydoclint --style=google <FILE_OR_FOLDER>
Expand Down

0 comments on commit 2c2fe09

Please sign in to comment.