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

#thumb("") comment causes inconsistent node description based on OS #210

Open
jgrenda opened this issue Feb 28, 2024 · 0 comments
Open

#thumb("") comment causes inconsistent node description based on OS #210

jgrenda opened this issue Feb 28, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation godot-change Requires changing the Godot Source Code

Comments

@jgrenda
Copy link
Collaborator

jgrenda commented Feb 28, 2024

Node descriptions (Script Documentation Comments) are a vital part of the exploration possibilities when adding a new node.
image

Usually these are marked by '##' and contain a short and/or long description of the node/script, like so:

## The ClockBehavior is a [class Behavior] that encasulates a [class Timer]
## and makes it accessible to other behaviors.

However, this description appears to only load into the node addition dialog based on the underlying OS.
Tested:

  • Win10 Home 22H2 19045.4046 -> Displayed in Node Addition Dialog
  • Ubuntu 20.04.6 LTS -> Not displayed, shows "No description available for Behavior"
    Both OS had the Version v4.2.1.stable.official [b09f793f5] of Godot installed.

My guess is this is caused by the #thumb("") annotation in line 2 of each Behavior script.
For some reason, the Ubuntu version of Godot handles this differently from the Windows version.
When the #thumb("") annotation is removed or moved below the descriptive comments, the Ubuntu version "sometimes" displays the correct description.

Therefore, either move the #thumb annotation below the descriptive comments or take it up with the godot project:
https://github.com/godotengine/godot/issues

@jgrenda jgrenda added bug Something isn't working documentation Improvements or additions to documentation godot-change Requires changing the Godot Source Code labels Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation godot-change Requires changing the Godot Source Code
Projects
None yet
Development

No branches or pull requests

1 participant