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.4beta1][Editor] GDScript documentation comments inconsistent behavior (## ) #101805

Open
agshultz opened this issue Jan 19, 2025 · 2 comments
Open

Comments

@agshultz
Copy link

agshultz commented Jan 19, 2025

Tested versions

v4.4.beta1.official

System information

Godot v4.4.beta1 - Windows 11 (build 26100) - Multi-window, 2 monitors - Vulkan (Forward+) - dedicated NVIDIA GeForce RTX 4090 (NVIDIA; 32.0.15.6590) - AMD Ryzen 9 7950X 16-Core Processor (32 threads)

Issue description

In-line gdscript documentation comments with a space following hash symbols are not prompting editor tooltips as suggested in the latest documentation/blog post. It's a little unclear if this was intended behavior, but based on wording I'm pretty sure it's not.

Presumably related to #91060

eg:

##This comment works as expected with a tooltip
new_func() -> void:

## This comment does not provide an in editor tooltip
another_func() -> void:

Steps to reproduce

##This comment works as expected with a tooltip
new_func() -> void:

## This comment does not provide an in editor tooltip
another_func() -> void:

Minimal reproduction project (MRP)

##This comment works as expected with a tooltip
new_func() -> void:

## This comment does not provide an in editor tooltip
another_func() -> void:
@PhairZ
Copy link
Contributor

PhairZ commented Jan 19, 2025

I can't seem to reproduce this bug, neither in v4.4.beta1.official nor in master (v4.4.beta.custom_build [7b1ed52] as of currently).

Image

@agshultz
Copy link
Author

It seems there is some inconsistent behavior, and probably not related to the comment space (## ) as I originally thought. Uploading simple MRP for clarity.

Using this example I can open the project, open autoload.gd in script editor, and by default hovering over either function reference does not show the expected tooltip - both with and without the space. If I CTRL+S to save the script (despite no changes being made), both tooltips now display as expected.

Image

mrp_editor_comments.zip

@agshultz agshultz changed the title [4.4beta1] GDScript documentation comments not providing editor hint when space following comment (## ) [4.4beta1][Editor] GDScript documentation comments inconsistent behavior (## ) Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants