spyder-ide / spyder

Official repository for Spyder - The Scientific Python Development Environment
https://www.spyder-ide.org
MIT License
8.37k stars 1.62k forks source link

Improve automatic generation of docstrings #10622

Open juanis2112 opened 5 years ago

juanis2112 commented 5 years ago

Issue Report Checklist

Problem Description

1) In the editor advanced settings, the shortcut Cmd+Alt+D established for adding docstring is reserved in Mac so it is necessary to change it. 2) When adding a docstring and trying to delete it pressing Cmd+z, the text is not deleted completely. 3) It is necessary to add an icon to show when the program is loading the docstring. Spyder just seem to be frozen while the docstring appears.

What steps reproduce the problem?

  1. Open advanced settings in editor
  2. Select dosctring
  3. Press cmd+alt+D

What is the expected output? What do you see instead?

It should generate the automatic docstring but it doesn't have any effect on Spyder.

Paste Traceback/Error Below (if applicable)


PASTE TRACEBACK HERE

Versions

Dependencies

PASTE DEPENDENCIES HERE
goanpeca commented 5 years ago

@juanis2112 what do you mean by this?

It is necessary to add an icon to show when the program is loading the docstring. Spyder just seem to be frozen while the docstring appears.

Could you post an animation?

juanis2112 commented 5 years ago

GIF-2019-11-06-10-29-06

ccordoba12 commented 5 years ago

Just for the record: Cmd+Alt+S seems to be available in macOS.

goanpeca commented 5 years ago

We need to move this work to a thread (to avoid freezes) plus adding the cursor change (+ status bar message) to signal de user.

dalthviz commented 5 years ago

Note: Ctrl+Alt+S is used for the Save All action

goanpeca commented 5 years ago

Note: Ctrl+Alt+S is used for the Save All action

Hmmm ok we need a different one :-p

jnsebgosselin commented 5 years ago

We need to move this work to a thread (to avoid freezes) plus adding the cursor change (+ status bar message) to signal de user.

Would it be possible to add a little timer for the popup too? This is very annoying because I end up very often adding a full automatic docstring by mistake when I only want to do a simple one-liner docstring.

autodocstrings