search

duesee / imap-codec

Rock-solid and complete codec for IMAP
Apache License 2.0
39 stars 14 forks source link

bindings(python): lint doc strings #572

Open duesee opened 2 months ago

duesee commented 2 months ago

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 commented 2 months ago

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