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

[4.0-rc1] Description not showing for gdscript properties in inspector #72952

Open
neilfranci opened this issue Feb 9, 2023 · 11 comments · May be fixed by #95821
Open

[4.0-rc1] Description not showing for gdscript properties in inspector #72952

neilfranci opened this issue Feb 9, 2023 · 11 comments · May be fixed by #95821

Comments

@neilfranci
Copy link

Godot version

4.0.rc1

System information

Window 10

Issue description

Relate to #59270

image

Steps to reproduce

Code use in image

extends Node2D

## Test
@export var test = 0

Minimal reproduction project

description_not_show.zip

@Loregret
Copy link

I have the same issue with Godot 4.0 Stable on Linux.

@neilfranci
Copy link
Author

I have the same issue with Godot 4.0 Stable on Linux.

Not fixed yet, this's on low priority I think. But it's on the go, so we need to wait because a lot of big issues need to fix first.

@and-rad
Copy link
Contributor

and-rad commented Mar 13, 2023

I bisected it and #71628 seems to be the PR that broke it.
CC @reduz

@voithos
Copy link
Contributor

voithos commented Nov 11, 2023

This seems to still be broken in 4.1.1, FYI.

@NathanReus
Copy link

Just started looking at Godot, doing the first 2D game tutorial in the docs and came across this same issue, still present in 4.2.1. Not a big deal by any means. I wish I knew enough to be able to try to open a PR and have a go at fixing it, but I'm nowhere near that level right now.

@h0lley
Copy link

h0lley commented Dec 22, 2023

this is another "sometimes" bug.
I have scenes where I get tooltips, and others where I do not.
similarly, a team member is not getting tooltips in a scene where I do.

@TheRedstoneScientist
Copy link

Also does not work using C#

@Snayff
Copy link

Snayff commented Aug 29, 2024

Still happening on 4.3 stable. I tried to do a bit of investigating, hopefully it helps.

  1. Property code:
    @export var root: Node2D ## physical or non physical node. Rigidbody2D is the only physical node handled.
  2. No docs in tooltip:
    image
  3. Can't open docs:
    image
  4. Delete all code following extends Node and save.
  5. Reinsert code and save.
  6. Docs in tooltip:
    image
  7. Can open docs:
    image

@betalars
Copy link
Contributor

This is kind of critical for me. I am shipping a project to a client and they need that documentation to understand how to work on it. I can confirm the observation by @Snayff tho.

If it is not freshly written, the descriptions will not show up consistently.

@anvilfolk
Copy link
Contributor

anvilfolk commented Sep 22, 2024

I can't test right now, but there's a good chance that #95821 fixes this. I would be especially interested if folks could test C# comments specifically. It should, but I don't have a local C# setup! Tagging @TheRedstoneScientist since you explicitly mentioned C# :)

You should be able to get the build artifacts by going to "Checks" and then "Artifacts"!

@anvilfolk
Copy link
Contributor

anvilfolk commented Sep 23, 2024

Quick update: did some quick tests with #95821 and it does indeed fix this issue at least w/ GDScript. It took launching the editor twice - probably something with cache propagation.

Edit: C# does not currently support documentation, so I don't believe there's a way for tooltips from C# [Export] variables to work in the inspector.

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.