godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.98k stars 3.23k forks source link

CanvasItem Range shows Float type when actually Double #8621

Open camerondedore opened 11 months ago

camerondedore commented 11 months ago

Your Godot Version: 4.2.0

Issue Description: Documentation for the Range class shows that the value of the range is the type Float. The definition of the Range class doesn't use any Float values. Instead, it uses Double.

It also shows a Float in the Editor's Node Signal Panel, and in the downloaded documentation.

URL to the documentation page: https://docs.godotengine.org/en/stable/classes/class_range.html

godot-range-samples

AThousandShips commented 11 months ago

This is because the GDScript implementation doesn't differentiate precision, and is documented here, here, and elsewhere

This is not a bug and is something that's documented, but it's possible that it could be documented better somewhere

Note however that the API documentation is primiarly aimed for the GDScript side, and has many points where the it differs from how it works in C#, or for that matter in C++ or GDExtension, so there's a balance to strike here, and adding further details might cause more confusion than it is worth

I believe adding dedicated documentation pages for C# and GDExtension has been discussed but unsure

camerondedore commented 11 months ago

Okay, so with that, my issue should be changed: It is not obvious what the parameter type should be for C# users.

It would be nice if the parameter was displayed as Double in .Net Godot's Node Signal panel.

If this would open up a can of worms and ideas are already being thrown around, I don't see a reason to rock the boat.