imap-codec icon indicating copy to clipboard operation
imap-codec copied to clipboard

bindings(python): lint doc strings

Open duesee opened this issue 1 year ago • 1 comments

The ˋparamˋ docstring refers to the name of the parameter, so "greeting" would have been correct before.

Taking a short look at it, I could not instantly find a tool that could check these. There might be extensions for other linters or one could write something simple for this case. If you think, this is something we should invest time into further down the road, feel free to create an issue.

Originally posted by @HenningHolmDE in https://github.com/duesee/imap-codec/pull/568#discussion_r1688548776

duesee avatar Jul 23 '24 19:07 duesee

This looks potentially useful: https://github.com/jsh9/pydoclint

duesee avatar Jul 23 '24 19:07 duesee