Mercurial Repositories > eric / file comparison
comparison: src/eric7/QScintilla/DocstringGenerator/SphinxdocGenerator.py
src/eric7/QScintilla/DocstringGenerator/SphinxdocGenerator.py
- branch
- eric7
- changeset 10683
- 779cda568acb
- parent 10439
- 21c28b0f9e41
- child 11090
- f5f5f5803935
equal
deleted
inserted
replaced
| 10682:47be220abdaf | 10683:779cda568acb |
|---|---|
| 6 """ | 6 """ |
| 7 Module implementing the docstring generator for the 'sphinxdoc' style. | 7 Module implementing the docstring generator for the 'sphinxdoc' style. |
| 8 """ | 8 """ |
| 9 | 9 |
| 10 | 10 |
| 11 def generateDoc(functionInfo, editor): # noqa: U100 | 11 def generateDoc(functionInfo, _editor): |
| 12 """ | 12 """ |
| 13 Function to generate the docstring line list iaw. Sphinx documentation | 13 Function to generate the docstring line list iaw. Sphinx documentation |
| 14 style. | 14 style. |
| 15 | 15 |
| 16 Note: Text is created with DESCRIPTION placeholders for descriptions and | 16 Note: Text is created with DESCRIPTION placeholders for descriptions and |
| 17 TYPE placeholders for type information | 17 TYPE placeholders for type information |
| 18 | 18 |
| 19 @param functionInfo object containing the function information to base | 19 @param functionInfo object containing the function information to base |
| 20 the docstring on | 20 the docstring on |
| 21 @type FunctionInfo | 21 @type FunctionInfo |
| 22 @param editor reference to the editor | 22 @param _editor reference to the editor (unused) |
| 23 @type Editor | 23 @type Editor |
| 24 @return list of docstring lines | 24 @return list of docstring lines |
| 25 @rtype str | 25 @rtype str |
| 26 """ | 26 """ |
| 27 # __IGNORE_WARNING_D202__ | 27 # __IGNORE_WARNING_D202__ |
