question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Explain CodeEditor's parameters within the doctring

See original GitHub issue

Issue Report Checklist

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:closed
  • Created 4 years ago
  • Reactions:1
  • Comments:11 (11 by maintainers)

github_iconTop GitHub Comments

2reactions
Akashtyagicommented, Apr 8, 2020

Working on it.

2reactions
dalthvizcommented, Apr 6, 2020

@Akashtyagi08 the missing initial descriptions:

  • occurrence_timeout : Timeout in milliseconds to start highlighting matches/occurrences for the current word under the cursor. Default 1500 ms.
  • tab_stop_width_spaces: Enable/Disable using tabs for indentation. Default True
  • auto_unindent: Enable/Disable automatically unindentation before else, elif, finally or except statements. Default True
  • scrollflagarea : Enable/Disable flag area that shows at the left of the scroll bar. Default True
  • strip_mode: Enable/Disable striping trailing spaces when modifying the file. Default False
  • occurrence_highlighting: Enable/Disable highlighting of current word occurrence in the file
  • intelligent_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). Default True
Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found