• Home
• org.sonarsource.python
• python-checks
• 4.25.0.19056
• source code
• S1720.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.sonar.l10n.py.rules.python.S1720.html Maven / Gradle / Ivy

Why is this an issue?
A string literal that is the first statement in a module, function, class, or method is a docstring. A docstring should document what a caller
needs to know about the code. Information about what it does, what it returns, and what it requires are all valid candidates for documentation. Well
written docstrings allow callers to use your code without having to first read it and understand its logic.
By convention, docstrings are enclosed in three sets of double-quotes.
Noncompliant code example
def my_function(a,b):

Compliant solution
def my_function(a,b):
      """Do X"""