check the ratio (comments + docstrings) / lines of code

[pylint-bot]

Originally reported by: Laura Médioni (BitBucket: lmedioni, GitHub: @lmedioni?)

---

A refactor message could be triggered when the ratio (comments + docstrings) / lines of code would be under a given limit.

• The ratio would be computed by function and by module
• It would be possible to configure 2 limits (one for the functions, one for the modules)
• It would be possible to configure a minimum number of lines under which the rule wouldn't apply on functions

---

• Bitbucket: https://bitbucket.org/logilab/pylint/issue/693

[PCManticore]

I don't think this checker is useful. The ratio is opinionated and there is no evidence that respecting the check will lead to code that's easier to understand or to maintain. It starts from the assumption that code with less docstrings or comments isn't as maintainable than code with them, which is from where the opinionated part comes from. Without having statistic evidence and a proper path to follow for the user in case it violates the rule, then it will bring more pain than solving any real problem. Following #746 I'm reticent to include checkers such as this one.