Skip to content

Commit

Permalink
Merge pull request #829 from sirosen/pylint-require-param-docs
Browse files Browse the repository at this point in the history
Move pylint config into setup.cfg and cleanup
  • Loading branch information
sirosen authored Aug 25, 2023
2 parents daaa643 + ff9148a commit 4ff8c66
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 41 deletions.
41 changes: 0 additions & 41 deletions .pylintrc

This file was deleted.

37 changes: 37 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,40 @@ categories =
Documentation
Security
Development


[pylint]
load-plugins = pylint.extensions.docparams

# accept-no-param-doc makes docparams behave as desired/expected and flag any
# method with missing param docs
# toggle this on and off manually until we can get the number of failures
# to 0, then leave it on
#
# accept-no-param-doc = false
[pylint.messages control]
disable =
# formatting and cosmetic rules (handled by 'black', etc)
format, C,
# refactoring rules (e.g. duplicate or similar code) are very prone to
# false positives
R,
# emitted when pylint fails to import a module; these warnings
# are usually false-positives for optional dependencies
import-error,
# "disallowed" usage of our own classes and objects gets underfoot
protected-access,
# logging-*-interpolation
# objections to log messages doing eager (vs lazy) string formatting
# this is potentially an area for improvement, but the benefit of deferred
# logging doesn't always outweigh the readability cost
logging-fstring-interpolation,
logging-format-interpolation,
# fixme comments are often useful; re-enable this to quickly find FIXME and
# TODO comments
fixme,
# most SDK methods currently do not document the exceptions which they raise
# this is an area for potential improvement
missing-raises-doc,
[pylint.variables]
ignored-argument-names = args|kwargs

0 comments on commit 4ff8c66

Please sign in to comment.