You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the problem or limitation you are having in your project
Having ability to jump between different sections in the documentation is a great feature, and works mostly well if you jump between classes. But if you have a relatively small class with lots of inner references, or the methods reside at the bottom of the list, I find it difficult to quickly identify the method/property of interest that way, because those references don't end up being placed at the top of the documentation window, so this breaks expectations, therefore makes the workflow slower.
Describe the feature / enhancement and how it helps to overcome the problem or limitation
I think that highlighting relevant sections would be enough to make it easier to navigate cross-references and inner references with long jumps.
Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams
Notice highlighted method description when clicking on the method reference above:
Fading away the highlighted area is also acceptable.
If this enhancement will not be used often, can it be worked around with a few lines of script?
It's a core documentation feature.
Is there a reason why this should be core and not an add-on in the asset library?
It's a core documentation feature.
The text was updated successfully, but these errors were encountered:
Good idea, but I don't know how we could implement this given the current feature set in RichTextLabel. godotengine/godot#35608 could help with this, but we'd have to rebuild the RichTextLabel every time you click a reference. This means the editor help would become less snappy.
We could just display a ColorRect over the relevant area.
Xrayez
changed the title
Make it easier to navigate built-in documentation while following references to methods/properties
Make it easier to navigate documentation while following references to methods/properties by highlighting help items
Nov 29, 2021
Describe the project you are working on
Goost - Godot Engine Extension.
Describe the problem or limitation you are having in your project
Having ability to jump between different sections in the documentation is a great feature, and works mostly well if you jump between classes. But if you have a relatively small class with lots of inner references, or the methods reside at the bottom of the list, I find it difficult to quickly identify the method/property of interest that way, because those references don't end up being placed at the top of the documentation window, so this breaks expectations, therefore makes the workflow slower.
Describe the feature / enhancement and how it helps to overcome the problem or limitation
I think that highlighting relevant sections would be enough to make it easier to navigate cross-references and inner references with long jumps.
Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams
Notice highlighted method description when clicking on the method reference above:
Fading away the highlighted area is also acceptable.
If this enhancement will not be used often, can it be worked around with a few lines of script?
It's a core documentation feature.
Is there a reason why this should be core and not an add-on in the asset library?
It's a core documentation feature.
The text was updated successfully, but these errors were encountered: