Explain CodeEditor's parameters within the doctring
See original GitHub issueIssue Report Checklist
- Searched the issues page for similar reports
Problem Description
There is not an explanation of the multiple parameters that a CodeEditor
instance can receive
Following suggestion at https://github.com/spyder-ide/spyder/pull/9897#discussion_r320016309
Issue Analytics
- State:
- Created 4 years ago
- Reactions:1
- Comments:11 (11 by maintainers)
Top Results From Across the Web
Python Docstring: Documenting And Introspecting Functions
This tutorial explains what is Python Docstring and how to use it to document Python functions with examples.
Read more >Python Docstrings Tutorial : Examples & Format for Pydoc ...
See Python Docstrings. Learn about the different types of docstrings & various docstring formats like Sphinx, Numpy, and Pydoc with examples now.
Read more >Specify types with docstrings | PyCharm Documentation
To specify the parameter types, follow these general steps ... Press Ctrl+Alt+S and go to Editor | General |Smart Keys. Select the Insert...
Read more >How to Use Python Docstrings for Effective Code Documentation
Docstrings explain what a function/class is needed for (i.e., its description, arguments, and output — and any other useful information) while ...
Read more >11 Comments, Docstrings, and Type Hints - Invent with Python
Type hints are directives you can add to your Python source code to specify the data types of variables, parameters, and return values....
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Working on it.
@Akashtyagi08 the missing initial descriptions:
occurrence_timeout
: Timeout in milliseconds to start highlighting matches/occurrences for the current word under the cursor. Default1500
ms.tab_stop_width_spaces
: Enable/Disable using tabs for indentation. DefaultTrue
auto_unindent
: Enable/Disable automatically unindentation beforeelse
,elif
,finally
orexcept
statements. DefaultTrue
scrollflagarea
: Enable/Disable flag area that shows at the left of the scroll bar. DefaultTrue
strip_mode
: Enable/Disable striping trailing spaces when modifying the file. DefaultFalse
occurrence_highlighting
: Enable/Disable highlighting of current word occurrence in the fileintelligent_backspace
: Enable/Disable automatically unindenting inserted text (unindenting happens if the leading text length of the line isn’t module of the length of indentation chars being use). DefaultTrue