Mercurial Repositories > eric / file diff

--- a/src/eric7/QScintilla/DocstringGenerator/SphinxdocGenerator.py	Wed Jul 13 11:16:20 2022 +0200
+++ b/src/eric7/QScintilla/DocstringGenerator/SphinxdocGenerator.py	Wed Jul 13 14:55:47 2022 +0200
@@ -12,10 +12,10 @@
     """
     Function to generate the docstring line list iaw. Sphinx documentation
     style.
-    
+
     Note: Text is created with DESCRIPTION placeholders for descriptions and
     TYPE placeholders for type information
-    
+
     @param functionInfo object containing the function information to base
         the docstring on
     @type FunctionInfo
@@ -24,34 +24,35 @@
     """
     # __IGNORE_WARNING_D202__
     lines = []
-    
+
     # function description
     lines.append("")
-    
+
     # remove 'self', 'this' or 'cls' from arguments list
-    if (
-        len(functionInfo.argumentsList) > 0 and
-        functionInfo.argumentsList[0][0] in ("self", "cls", "this")
+    if len(functionInfo.argumentsList) > 0 and functionInfo.argumentsList[0][0] in (
+        "self",
+        "cls",
+        "this",
     ):
         del functionInfo.argumentsList[0]
-    
+
     # add an empty line if there is one of the other sections
     if (
-        functionInfo.argumentsList or
-        functionInfo.hasYield or
-        functionInfo.returnTypeAnnotated or
-        functionInfo.returnValueInBody or
-        functionInfo.raiseList
+        functionInfo.argumentsList
+        or functionInfo.hasYield
+        or functionInfo.returnTypeAnnotated
+        or functionInfo.returnValueInBody
+        or functionInfo.raiseList
     ):
         lines.append("")
-    
+
     # add the parameters section
     for argName, argType, argValue in functionInfo.argumentsList:
         argLine = ":param {0}: DESCRIPTION".format(argName)
         if argValue:
             argLine += ", defaults to {0}".format(argValue)
         lines.append(argLine)
-        
+
         argLine = ":type {0}: ".format(argName)
         if argType:
             argLine += "{0}".format(argType)
@@ -60,28 +61,27 @@
         if argValue:
             argLine += ", optional"
         lines.append(argLine)
-    
+
     # add an exceptions section, if function raises something
     if functionInfo.raiseList:
         for exc in sorted(functionInfo.raiseList):
             lines.append(":raises {0}: DESCRIPTION".format(exc))
-    
+
     # add return section
     if (
-        functionInfo.hasYield or
-        functionInfo.returnValueInBody or
-        functionInfo.returnTypeAnnotated
+        functionInfo.hasYield
+        or functionInfo.returnValueInBody
+        or functionInfo.returnTypeAnnotated
     ):
         if functionInfo.hasYield:
             lines.append(":yield: DESCRIPTION")
         else:
             lines.append(":return: DESCRIPTION")
         if functionInfo.returnTypeAnnotated:
-            lines.append(":rtype: {0}".format(
-                functionInfo.returnTypeAnnotated))
+            lines.append(":rtype: {0}".format(functionInfo.returnTypeAnnotated))
         else:
             lines.append(":rtype: TYPE")
-    
+
     lines.append("")
-    
+
     return lines