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

Allow jumping directly to a Godot function call's documentation #221

Closed
Naros opened this issue Mar 31, 2024 · 3 comments · Fixed by #329
Closed

Allow jumping directly to a Godot function call's documentation #221

Naros opened this issue Mar 31, 2024 · 3 comments · Fixed by #329
Labels
kind/enhancement New feature or request requires/godot-change Requires a change to upstream Godot.
Milestone

Comments

@Naros
Copy link
Member

Naros commented Mar 31, 2024

Description

For example, given the following Call function, which calls start() on a Timer:
image

The context menu has a View Documentation option, it would be more useful if either Orchestrator was able to render information about the function, its signature, and description. If that isn't possible due to GDExtension limitations, would it be at least possible to refer the user to the actual function documentation as there should be sufficient context to redirect there, i.e.:

image

Implementation ideas

No response

@Naros Naros added the kind/enhancement New feature or request label Mar 31, 2024
@Naros Naros added this to the 2.1 milestone Mar 31, 2024
@Naros
Copy link
Member Author

Naros commented Apr 4, 2024

So Godot 4.3 has broken how we interfaced with documentation, with no replacement. Looking at whether we should consider implementing the UI as a ScriptEditorBase implementation from the engine's source, this is also not possible because GDE does not expose a way for contributors to register custom editors. 😞

So this may be a bit before we can get to it as we'll need to open a feature request to the editor.

@Naros Naros added the requires/godot-change Requires a change to upstream Godot. label Apr 4, 2024
@Naros
Copy link
Member Author

Naros commented Apr 4, 2024

Looking at the Godot editor source, we have a couple of options:

  1. Request that EditorInterface expose a goto_help(String&) method that accepts a full topic descriptor.
  2. Request that ScriptEditor expose its goto_help method that takes a full topic descriptor.

I think both of these would solve our issue, the main question is whether this can get into Godot 4.3.

@Naros
Copy link
Member Author

Naros commented Apr 4, 2024

Created upstream PR - godotengine/godot#90189

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request requires/godot-change Requires a change to upstream Godot.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant