src/eric7/QScintilla/DocstringGenerator/EricdocGenerator.py

branch
eric7
changeset 9486
5a8179763e38
parent 9221
bf71ee032bb4
child 9653
e67609152c5e
--- a/src/eric7/QScintilla/DocstringGenerator/EricdocGenerator.py	Tue Nov 08 11:34:19 2022 +0100
+++ b/src/eric7/QScintilla/DocstringGenerator/EricdocGenerator.py	Tue Nov 08 11:50:50 2022 +0100
@@ -8,16 +8,19 @@
 """
 
 
-def generateEricDoc(functionInfo):
+def generateDoc(functionInfo, editor):
     """
-    Function to generate the docstring line list iaw. eric documentation style.
+    Function to generate the docstring line list iaw. eric documentation
+    style.
 
-    Note: Partial English text is created with DESCRIPTION placeholders
-    for descriptions and TYPE placeholders for type information
+    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
+    @param editor reference to the editor
+    @type Editor
     @return list of docstring lines
     @rtype str
     """

eric ide

mercurial