jsh9 pydoclint issues - Githubissues

jsh9 / pydoclint

A Python docstring linter that checks arguments, returns, yields, and raises sections

https://pypi.org/project/pydoclint/

MIT License

123 stars 13 forks source link

issues

Newest

Newest Most commented Recently updated Oldest Least commented Least recently updated

Add an option for private class attributes

#149 jsh9 closed 1 day ago
0
Issues with check-class-attributes and properties, as well as 'private' class variables

#148 Midnighter opened 1 week ago
0
Add DOC604 & 605 test cases; improve DOC605 err msg

#147 jsh9 closed 1 week ago
0
Don't report DOC109 if arg list is empty

#146 jsh9 closed 1 week ago
0
Don't report DOC6xx if no docstring or short docstring

#145 jsh9 closed 1 week ago
0
Tab vs. spaces in baseline

#143 cidrblock opened 1 week ago
1
DOC101: allow whitelisting specific arguments from being required for the docstring

#142 ssbarnea opened 1 week ago
1
pydoclint wrongly assumes that any filesystem node ending in .py is a file

#141 ssbarnea opened 1 week ago
0
check-class-attributes=True does not work for attrs-class

#140 Waschenbacher opened 1 week ago
0
pydoclint 0.5.2 fails to find violation in a particular folder

#139 jsh9 opened 1 week ago
4
False positive when documenting dataclass attributes for Sphinx

#138 darosio opened 1 week ago
2
Make url a proper link

#137 Gabriel-p closed 1 week ago
1
Use "attribute" docstring section in Sphinx style

#136 jsh9 closed 1 week ago
0
pydoclint raises AttributeError on class with a Union type

#135 neilo-df closed 1 week ago
4
Add special treatment for Sphinx style in class attr

#134 jsh9 closed 1 week ago
1
Fix another bug in class attr checking

#133 jsh9 closed 1 week ago
0
Fix annotation unparsing bug

#132 jsh9 closed 1 week ago
0
Use py310+ type annotations

#131 jsh9 closed 1 week ago
2
Check class attributes against docstring

#130 jsh9 closed 1 week ago
0
Improve DOC403 message

#129 jsh9 closed 1 month ago
0
Check for missing or incorrectly formatted docstring

#128 cidrblock closed 1 month ago
1
False positive 403 with "yield from" statement

#127 pplantinga closed 1 month ago
1
False positive DOC405

#126 ddelange opened 4 months ago
6
False positive DOC201

#125 ddelange opened 4 months ago
1
Remove useless argument `--src`

#124 jsh9 closed 4 months ago
0
Fix double quotes in Literal type hint

#123 jsh9 closed 4 months ago
0
Add class attributes checking support

#122 Oreilles closed 1 week ago
9
Google style: Allow omitting `*args` and `**kwargs` from doc string

#121 math411 opened 4 months ago
3
Include args with different type hints in DOC105 msg

#120 jsh9 closed 4 months ago
0
Add option to show filename for each violation msg

#119 jsh9 closed 4 months ago
0
Add option to output with filename for each error.

#118 gigi-minds-ai closed 4 months ago
2
Deprecated command line argument `--src` leads to errors or missing proper documentation

#117 kesmik closed 4 months ago
2
Exclude venv folders in flake8

#116 jamesbraza closed 5 months ago
0
Fix false positive DOC203 in property methods

#115 jsh9 closed 5 months ago
0
Option to only check for non-existent params in pydocs, rather than params missing in pydocs

#114 JessieSteckling closed 5 months ago
2
More config control for type hinting in signature

#113 JessieSteckling closed 5 months ago
2
Allow more control over`--skip-checking-short-docstrings`

#112 llucax opened 5 months ago
4
Google style: Allow documenting `@property`s as a member

#111 llucax closed 4 months ago
5
Google style: Allow omitting only the `Returns`/`Yields` if summary starts with `Return(s)/Yield(s)`

#110 llucax opened 5 months ago
16
Failure to detect `noqa` statement

#109 ddelange closed 4 months ago
5
Failure to detect the `import typing as tt` convention

#108 ddelange closed 6 months ago
2
**kwargs only arguments throw DOC106 and DOC109

#107 OliverKleinBST closed 5 months ago
2
Request: Add configuration option that allows for type hint in signature _or_ docstring, but not both

#106 dvmcconnell closed 6 months ago
2
BUG: Return literal with double quotes incorrectly raises v203

#105 ShivMunagala closed 4 months ago
3
Documenting tool integration

#104 jamesbraza closed 5 months ago
3
Add shortcuts for long typing.Annotated type hints

#103 lecode-official opened 7 months ago
3
Parameters not processed correctly for numpy style with incorrect underscoring

#102 d3nzil opened 7 months ago
1
Docs request: `pre-commit` config for `flake8`

#101 jamesbraza closed 5 months ago
1
Request: not throwing DOC501 for `abstractmethod`

#100 jamesbraza opened 8 months ago
2
Request: ability to disable certain codes explicitly via config

#99 jamesbraza closed 8 months ago
2