DAR101 on private methods if docstring exists

terrencepreilly / darglint

A python documentation linter which checks that the docstring description matches the definition.

MIT License

481 stars 41 forks source link

DAR101 on private methods if docstring exists #188

Open mvadari opened 2 years ago

mvadari commented 2 years ago

I had an issue where if there was a docstring on a private method, darglint would insist on there being parameters as a part of the docstring. But if the docstring was removed, then it would stop complaining. darglint should not mandate parameters for a private method just because a docstring happens to exist there.