godotengine / godotengine/godot-docs

`atan2` in @GlobalScope, i think it would be clearest to include the range of the function

Open
#10,708 0 comments 0 reactions 0 assignees View on GitHub
area:class reference discussion enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
4.3

**Issue description:**
Although atan2 commonly has a range between -pi and pi, I think it would still be best to explicitly include this information on the docs page. For example, in trig classes, you learn that tan(x) either has a range from 0 to 2pi or -pi to pi, and so if you start doing gamedev and use the atan2 function, you might expect one or the other of these to be stated somewhere. Of course atan2 is a different function, which almost always has a range of between -pi and pi, but I think for beginnners it could help, and its only like 1 extra line in the docs.

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/classes/class_@globalscope.html#class-globalscope-method-atan2

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.