src/eric7/QScintilla/DocstringGenerator/BaseDocstringGenerator.py

branch
eric7
changeset 10683
779cda568acb
parent 10665
66564661c3b5
child 11090
f5f5f5803935
diff -r 47be220abdaf -r 779cda568acb src/eric7/QScintilla/DocstringGenerator/BaseDocstringGenerator.py
--- a/src/eric7/QScintilla/DocstringGenerator/BaseDocstringGenerator.py	Tue Apr 16 15:47:11 2024 +0200
+++ b/src/eric7/QScintilla/DocstringGenerator/BaseDocstringGenerator.py	Sat Apr 20 18:01:36 2024 +0200
@@ -55,7 +55,7 @@
         Public method to test, if a text is the start of a function or method
         definition.
 
-        @param text line of text to be tested
+        @param text line of text to be tested (unused)
         @type str
         @return flag indicating that the given text starts a function or
             method definition (always False)
@@ -68,7 +68,7 @@
         Public method to test, if the cursor is right below a function
         definition.
 
-        @param cursorPosition current cursor position (line and column)
+        @param cursorPosition current cursor position (line and column) (unused)
         @type tuple of (int, int)
         @return flag indicating cursor is right below a function definition
         @rtype bool
@@ -80,7 +80,7 @@
         Public function to test, if the line up to the cursor position might be
         introducing a docstring.
 
-        @param cursorPosition current cursor position (line and column)
+        @param cursorPosition current cursor position (line and column) (unused)
         @type tuple of (int, int)
         @return flag indicating a potential start of a docstring
         @rtype bool
@@ -92,10 +92,10 @@
         Public method to insert a docstring for the function at the cursor
         position.
 
-        @param cursorPosition position of the cursor (line and index)
+        @param cursorPosition position of the cursor (line and index) (unused)
         @type tuple of (int, int)
         @param fromStart flag indicating that the editor text cursor is placed
-            on the line starting the function definition
+            on the line starting the function definition (unused)
         @type bool
         """
         # just do nothing in the base class
@@ -106,7 +106,7 @@
         Public method to insert a docstring for the function at the cursor
         position initiated via a keyboard shortcut.
 
-        @param cursorPosition position of the cursor (line and index)
+        @param cursorPosition position of the cursor (line and index) (unused)
         @type tuple of (int, int)
         """
         # just do nothing in the base class

eric ide

mercurial