Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial code and config #1

Merged
merged 40 commits into from
May 15, 2023
Merged
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
69a4316
Upload initial code and config
jsh9 May 14, 2023
3ad6069
Tweak main.py
jsh9 May 14, 2023
838490e
Add flake8 integration; improve main.py
jsh9 May 14, 2023
8c56232
Update error msg format
jsh9 May 14, 2023
f28248e
Adjust import position
jsh9 May 14, 2023
ae37125
Add Cercis to pre-commit; auto-format
jsh9 May 14, 2023
042410c
Fix file path in tests
jsh9 May 14, 2023
01e48e3
Make flake8 optional
jsh9 May 14, 2023
538868c
Add new hooks; auto-format
jsh9 May 14, 2023
b3d2d8c
Add tox and fix style
jsh9 May 14, 2023
a644f23
Add github action scripts
jsh9 May 14, 2023
2a23de2
Fix typo
jsh9 May 14, 2023
672db5b
Make syntax compatible with py39-
jsh9 May 14, 2023
9e93d56
Fix backward incompatiblity
jsh9 May 14, 2023
1d9ce8f
Fix a bug with quoted annotations
jsh9 May 14, 2023
de78157
Update pre-commit stuff
jsh9 May 14, 2023
8f94f51
Make code py37/p38 compatible
jsh9 May 14, 2023
586bf43
Rename command line argument
jsh9 May 14, 2023
26d34b4
Another tweak to be compatible with py37
jsh9 May 14, 2023
fc2219f
Fix typo
jsh9 May 14, 2023
ecf5105
Add option "skipCheckingShortDocstrings"
jsh9 May 14, 2023
d784708
Drop py37 support
jsh9 May 14, 2023
2e2b0e2
Auto-format
jsh9 May 14, 2023
46caed0
Fix flake8
jsh9 May 14, 2023
e778859
Fix a bug in parseAnnotation()
jsh9 May 14, 2023
84e116b
Fix a bug that cannot detect some empty docstrings
jsh9 May 14, 2023
2b812e2
Add a tox step to check self
jsh9 May 14, 2023
15db9ad
Fix long line
jsh9 May 14, 2023
152223c
Add DOC3 violations
jsh9 May 15, 2023
e16e829
Improve msg wordking in DOC103
jsh9 May 15, 2023
be9cd74
Rename a compound type
jsh9 May 15, 2023
bdd441b
Add "yield" checking (DOC4xx)
jsh9 May 15, 2023
6371190
Rename module
jsh9 May 15, 2023
1bf3cb7
Add "raise" checking (DOC5xx)
jsh9 May 15, 2023
20c20d9
Add `playground.py` and placeholder test
jsh9 May 15, 2023
c4b0d50
Make command line output pretty
jsh9 May 15, 2023
0e23791
Add cmd line option to flake8 plugin
jsh9 May 15, 2023
4cc4574
Auto format
jsh9 May 15, 2023
cef0ec2
Add docstring
jsh9 May 15, 2023
e19352f
Add README; adjust setup.cfg
jsh9 May 15, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix typo
  • Loading branch information
jsh9 committed May 14, 2023
commit fc2219f5b895d03cf5a5614882a4a87c5f950a2a
4 changes: 2 additions & 2 deletions pydoclint/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@
help='Whether to check type hints in docstrings',
)
@click.option(
'-th',
'-ao',
'--check-arg-order',
type=bool,
show_default=True,
default=True,
help='Whether to check docstring argument order agasint function signature',
help='Whether to check docstring argument order against function signature',
)
@click.argument(
'paths',
Expand Down