eric6/QScintilla/DocstringGenerator/BaseDocstringGenerator.py

changeset 8000
47b15df088e4
parent 7998
cd41c844862f
child 8143
2c730d5fd177
equal deleted inserted replaced
7999:159689297bc0 8000:47b15df088e4
96 on the line starting the function definition 96 on the line starting the function definition
97 @type bool 97 @type bool
98 """ 98 """
99 # just do nothing in the base class 99 # just do nothing in the base class
100 return 100 return
101 101
102 def insertDocstringFromShortcut(self, cursorPosition):
103 """
104 Public method to insert a docstring for the function at the cursor
105 position initiated via a keyboard shortcut.
106
107 @param cursorPosition position of the cursor (line and index)
108 @type tuple of (int, int)
109 """
110 # just do nothing in the base class
111 return
112
102 def getDocstringType(self): 113 def getDocstringType(self):
103 """ 114 """
104 Public method to determine the docstring type to be generated. 115 Public method to determine the docstring type to be generated.
105 116
106 @return docstring type (one of 'ericdoc', 'numpydoc', 'googledoc', 117 @return docstring type (one of 'ericdoc', 'numpydoc', 'googledoc',

eric ide

mercurial