eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.BaseDocstringGenerator.html

changeset 8000
47b15df088e4
parent 7998
cd41c844862f
child 8215
fc5d68a6889e
--- a/eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.BaseDocstringGenerator.html	Fri Jan 22 16:55:43 2021 +0100
+++ b/eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.BaseDocstringGenerator.html	Sat Jan 23 12:02:52 2021 +0100
@@ -101,6 +101,10 @@
 <td>Public method to insert a docstring for the function at the cursor position.</td>
 </tr>
 <tr>
+<td><a href="#BaseDocstringGenerator.insertDocstringFromShortcut">insertDocstringFromShortcut</a></td>
+<td>Public method to insert a docstring for the function at the cursor position initiated via a keyboard shortcut.</td>
+</tr>
+<tr>
 <td><a href="#BaseDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td>
 <td>Public function to test, if the line up to the cursor position might be introducing a docstring.</td>
 </tr>
@@ -227,6 +231,21 @@
             on the line starting the function definition
 </dd>
 </dl>
+<a NAME="BaseDocstringGenerator.insertDocstringFromShortcut" ID="BaseDocstringGenerator.insertDocstringFromShortcut"></a>
+<h4>BaseDocstringGenerator.insertDocstringFromShortcut</h4>
+<b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>)
+
+<p>
+        Public method to insert a docstring for the function at the cursor
+        position initiated via a keyboard shortcut.
+</p>
+<dl>
+
+<dt><i>cursorPosition</i> (tuple of (int, int))</dt>
+<dd>
+position of the cursor (line and index)
+</dd>
+</dl>
 <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a>
 <h4>BaseDocstringGenerator.isDocstringIntro</h4>
 <b>isDocstringIntro</b>(<i>cursorPosition</i>)

eric ide

mercurial