Parcourir la source

Merge pull request #50726 from Calinou/doc-gdscript-constants

Improve documentation for GDScript constants
Rémi Verschelde il y a 4 ans
Parent
commit
c40b4f2252
1 fichiers modifiés avec 6 ajouts et 4 suppressions
  1. 6 4
      modules/gdscript/doc_classes/@GDScript.xml

+ 6 - 4
modules/gdscript/doc_classes/@GDScript.xml

@@ -241,16 +241,18 @@
 	</methods>
 	<constants>
 		<constant name="PI" value="3.14159265358979">
-			Constant that represents how many times the diameter of a circle fits around its perimeter. This is equivalent to [code]TAU / 2[/code].
+			Constant that represents how many times the diameter of a circle fits around its perimeter. This is equivalent to [code]TAU / 2[/code], or 180 degrees in rotations.
 		</constant>
 		<constant name="TAU" value="6.28318530717959">
-			The circle constant, the circumference of the unit circle in radians.
+			The circle constant, the circumference of the unit circle in radians. This is equivalent to [code]PI * 2[/code], or 360 degrees in rotations.
 		</constant>
 		<constant name="INF" value="inf">
-			Positive infinity. For negative infinity, use -INF.
+			Positive floating-point infinity. This is the result of floating-point division when the divisor is [code]0.0[/code]. For negative infinity, use [code]-INF[/code]. Dividing by [code]-0.0[/code] will result in negative infinity if the numerator is positive, so dividing by [code]0.0[/code] is not the same as dividing by [code]-0.0[/code] (despite [code]0.0 == -0.0[/code] returning [code]true[/code]).
+			[b]Note:[/b] Numeric infinity is only a concept with floating-point numbers, and has no equivalent for integers. Dividing an integer number by [code]0[/code] will not result in [constant INF] and will result in a run-time error instead.
 		</constant>
 		<constant name="NAN" value="nan">
-			"Not a Number", an invalid value. [code]NaN[/code] has special properties, including that it is not equal to itself. It is output by some invalid operations, such as dividing zero by zero.
+			"Not a Number", an invalid floating-point value. [constant NAN] has special properties, including that it is not equal to itself ([code]NAN == NAN[/code] returns [code]false[/code]). It is output by some invalid operations, such as dividing floating-point [code]0.0[/code] by [code]0.0[/code].
+			[b]Note:[/b] "Not a Number" is only a concept with floating-point numbers, and has no equivalent for integers. Dividing an integer [code]0[/code] by [code]0[/code] will not result in [constant NAN] and will result in a run-time error instead.
 		</constant>
 	</constants>
 </class>