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

Differentiate Godot reference help vs Orchestrator help #616

Open
Naros opened this issue Jul 29, 2024 · 0 comments
Open

Differentiate Godot reference help vs Orchestrator help #616

Naros opened this issue Jul 29, 2024 · 0 comments
Labels
cherrypick:2.0 Requires cherry-pick to Orchestrator 2.0 cherrypick:2.1 Requires cherry-pick to Orchestrator 2.1 kind/enhancement New feature or request
Milestone

Comments

@Naros
Copy link
Member

Naros commented Jul 29, 2024

Description

When selecting View Documentation on nodes, specific nodes will take the user to the Godot documentation for the class, method, signal, property, or constant definition. While we want to retain this behavior, its confusing that sometimes the user is taken to this in-depth documentation rather than details about what the script node does.

Implementation ideas

The context-menu should present two unique options:

  • View documentation which will take the user to the script node's documentation
  • Godot reference which will take the user to the class, method, signal, property, or constant documentation.

The Godot reference context-menu option should be dynamically added based on whether the node actually has any Godot-specific reference documentation link or not. For nodes like many flow-control, there would be no such link while for function call and constant nodes, there would be.

@Naros Naros added kind/enhancement New feature or request cherrypick:2.0 Requires cherry-pick to Orchestrator 2.0 cherrypick:2.1 Requires cherry-pick to Orchestrator 2.1 labels Jul 29, 2024
@Naros Naros added this to the 2.2 milestone Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick:2.0 Requires cherry-pick to Orchestrator 2.0 cherrypick:2.1 Requires cherry-pick to Orchestrator 2.1 kind/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant