Skip to content

Commit 8b89a2c

Browse files
authored
Fix a typo in the documentation (#242)
1 parent 37fa474 commit 8b89a2c

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Change Log
22

3-
## [Unpublished]
3+
## [0.6.7] - 2025-05-18
44

55
- Changed
66
- Reverted the default behavior of `--quiet` to be `False`
7+
- Fixed
8+
- Fixed a typo in the documentation
9+
- Full diff
10+
- https://github.com/jsh9/pydoclint/compare/0.6.6...0.6.7
711

812
## [0.6.6] - 2025-04-16
913

docs/config_options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ page:
3030
- [17. `--treat-property-methods-as-class-attributes` (shortform: `-tpmaca`, default: `False`)](#17---treat-property-methods-as-class-attributes-shortform--tpmaca-default-false)
3131
- [18. `--only-attrs-with-ClassVar-are-treated-as-class-attrs` (shortform: `-oawcv`, default: `False)](#18---only-attrs-with-classvar-are-treated-as-class-attrs-shortform--oawcv-default-false)
3232
- [19. `--should-document-star-arguments` (shortform: `-sdsa`, default: `True`)](#19---should-document-star-arguments-shortform--sdsa-default-true)
33-
- [20. `--check-style-mismatch` (shortform: `-csm`, default: `True`)](#20---check-style-mismatch-shortform--csm-default-true)
33+
- [20. `--check-style-mismatch` (shortform: `-csm`, default: `False`)](#20---check-style-mismatch-shortform--csm-default-false)
3434
- [21. `--baseline`](#21---baseline)
3535
- [22. `--generate-baseline` (default: `False`)](#22---generate-baseline-default-false)
3636
- [23. `--auto-regenerate-baseline` (shortform: `-arb`, default: `True`)](#23---auto-regenerate-baseline-shortform--arb-default-true)
@@ -228,7 +228,7 @@ If True, "star arguments" (such as `*args`, `**kwargs`, `**props`, etc.)
228228
in the function signature should be documented in the docstring. If False,
229229
they should not appear in the docstring.
230230

231-
## 20. `--check-style-mismatch` (shortform: `-csm`, default: `True`)
231+
## 20. `--check-style-mismatch` (shortform: `-csm`, default: `False`)
232232

233233
If True, check that style specified in --style matches the detected
234234
style of the docstring. If there is a mismatch, DOC003 will be

0 commit comments

Comments
 (0)