Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display quick documentation with code completion hints in the script editor #1573

Closed
ghost opened this issue Sep 26, 2020 · 1 comment
Closed

Comments

@ghost
Copy link

ghost commented Sep 26, 2020

Describe the project you are working on:
Experimenting with using Visual Studio Code as external editor.

Describe the problem or limitation you are having in your project:
Using Visual Studio Code as the auto-completion hints describe what a function does rather than just display a list of functions to choose from which is how the Godot editor behaves currently.
current

Describe the feature / enhancement and how it helps to overcome the problem or limitation:
Especially when you can't remember what a function is supposed to do, yes you can look it up in the documentation, however it would be more convenient to have the auto-completion hints text showing, similar to the godot-tools extension does in Visual Studio Code. This will make the experience of using the internal editor better.
suggestion

Describe how your proposal will work, with code, pseudocode, mockups, and/or diagrams:
For each function that appears in the auto-complete dropdown, full hints are displayed. This would be derived from the Godot documentation which is how the godot-tools is working.

If this enhancement will not be used often, can it be worked around with a few lines of script?:
No. The only alternative is to use the external editor, however the suggestion is about making the experience using the internal editor better.

Is there a reason why this should be core and not an add-on in the asset library?:
This is an editor enhancement.

@ghost ghost changed the title Godot Code-Completion hints, similar to the godot-tools VS-Code extension Godot code completion hints for the internal editor, similar to the godot-tools VS-Code extension Sep 26, 2020
@Calinou Calinou changed the title Godot code completion hints for the internal editor, similar to the godot-tools VS-Code extension Display quick documentation with code completion hints in the script editor Sep 26, 2020
@Calinou
Copy link
Member

Calinou commented Sep 26, 2020

Duplicate of #408.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant