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

GDScript 2.0: Documentation comments do not appear in inspector tooltips #59270

Closed
h0lley opened this issue Mar 18, 2022 · 5 comments · Fixed by #62936
Closed

GDScript 2.0: Documentation comments do not appear in inspector tooltips #59270

h0lley opened this issue Mar 18, 2022 · 5 comments · Fixed by #62936

Comments

@h0lley
Copy link

h0lley commented Mar 18, 2022

Godot version

v4.0.alpha4.official [f470979]

System information

Ubuntu, Nvidia, Vulkan

Issue description

Looking at the merged PR #41095, inspector tooltips for @export variables should already be implemented. However, I can't get them to show up. They do appear in the documentation (F1) just fine, but the tooltip text remains "No description".

image

A restart of the editor does not help.

Steps to reproduce

Code used in above example:

extends Node
class_name MyClass

## My documentation for my_inspector_setting
@export var my_inspector_setting: int

Or get the minimal reproduction project,

  1. Press F1 and check the docs of MyClass, notice the description of my_inspector_setting
  2. Open main.tscn and hover the property in the inspector, notice "No description"

Minimal reproduction project

Godot 4 Inspector tooltip.zip

@Calinou Calinou added this to the 4.0 milestone Mar 18, 2022
@Calinou Calinou changed the title Documentation comments do not appear in inspector tooltips GDScript 2.0: Documentation comments do not appear in inspector tooltips Mar 18, 2022
@KoBeWi KoBeWi removed this from the 4.0 milestone Apr 25, 2022
@FaerDerr
Copy link

What's up with this feature ?
This has been removed from the 4.0 milestone, is it expected to be in 3.5 or is it just stranded ?

@akien-mga
Copy link
Member

It's not critical to solve before releasing 4.0, so in such case we don't put a milestone, which just means it will be fixed when it's fixed. Would still be nice to have fixed in 4.0 of course if anyone wants to work on it.

@FaerDerr
Copy link

Original proposal has been around since 2016 ( #4370 )
Couldn't we do something to speed up the process for 4.0 ? Maybe asking directly in discord or something, It seems like a long-requested update

@akien-mga
Copy link
Member

That proposal has been implemented already, and works fine. What's missing is literally just hooking it up in tooltips, which can be done by any motivated contributor.

@h0lley
Copy link
Author

h0lley commented May 21, 2022

in opening post I mentioned that this should already be implemented judging by the screenshot in #41095 so I thought let's bisect it, but I just compiled 42bfa16 and was still unable to get tooltips, so perhaps the screenshot was just a concept.
@ThakeeNathees perhaps you could clarify. have tooltips been implemented at some point?

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

Successfully merging a pull request may close this issue.

5 participants