7adf4cc9b5
doc: Use self-closing tags for `return` and `argument`
...
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
8ff8c1e5f8
Improve documentation for GDScript constants
2021-07-22 09:50:24 +02:00
e28fd07b2b
Rename `instance()`->`instantiate()` when it's a verb
2021-06-19 20:49:18 -06:00
09a905ca80
Increase String::num default decimal precision
...
Fixes #34541
Renamed MAX_DIGITS to MAX_DECIMALS, since it only changes the
amount of digits after the decimal point.
Increased MAX_DECIMALS to 32, and made String::num use
MAX_DECIMALS consistently. If -1 is passed as
decimal precision to String::num, it now gets changed to
the correct precision based on the number's magnitude,
instead of using printf default(which is 6)
String::num_real also calculates the correct precision now.
Also made the types used in floating-point math more
consistent in a few places.
2021-05-29 11:24:57 -04:00
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
b743a2ef3c
Rename Math::stepify to snapped
2020-12-28 13:01:30 +00:00
4fd20015f3
Pow method doc fix
2020-12-13 17:53:30 -05:00
bf96056ad0
Several edits to the GDScript docs
2020-12-01 16:05:10 +03:00
fbb806fd68
Unregister GDScriptFunctionState class
...
This is not user accessible anymore so it does not need to be show in
documentation.
2020-11-26 21:39:54 -03:00
68067b8d97
Merge pull request #43423 from Calinou/doc-assert-avoid-side-effects
...
Clarify that code in `assert()` should avoid side effects
2020-11-10 11:31:28 +01:00
0f249f5c0a
Variant: Sync docs with new constructors, fixups after #43403
...
Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
2020-11-09 23:39:53 +01:00
d6c7073bd7
Clarify that code in `assert()` should avoid side effects
2020-11-09 21:48:24 +01:00
38fb26794b
Exposed randi_range to global funcs + renamed rand_range to randf_range
2020-11-06 17:06:26 +03:00
802c1e4df1
Link the Random number generation tutorial in the class reference
2020-10-14 18:03:29 +02:00
3556bc48a1
Merge pull request #42439 from Xrayez/doc-gdscript-load-and-resloader-xref
...
Cross-reference GDScript `load` and `ResourceLoader.load` in classref
2020-10-04 20:48:07 +02:00
9f2cdfea82
Fixed padding bug of sprintf function
2020-10-02 00:25:42 +03:00
a8404cf56c
Cross-reference GDScript `load` and `ResourceLoader.load` in classref
...
The GDScript `load` mention is moved from the class `ResourceLoader`
description to the `ResourceLoader.load` method description instead,
where it is more likely to be found.
2020-09-30 23:03:36 +03:00
50f3a8e312
Improve documentation related to printing error/warning messages
2020-09-24 14:23:53 +02:00
a4c5790350
Several documentation improvements
2020-09-14 20:02:19 +03:00
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
20d0f5bbd7
Cross-reference GDScript built-in rounding methods to ease discovery
...
This closes #19315 .
2020-08-28 17:04:22 +02:00
ba853f86af
Merge pull request #40903 from Calinou/doc-json
...
Improve JSON-related documentation
2020-07-31 10:39:56 +02:00
930e10ffff
Improve JSON-related documentation
...
This closes https://github.com/godotengine/godot-docs/issues/3848 .
2020-07-31 09:56:11 +02:00
9833f9cc11
doc: Fix typo in BBcode tag
2020-07-30 16:24:37 +02:00
932b75e247
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
7f9bfee0ac
GDScript: Clarified/fixed inaccuracies in the built-in function docs.
...
The input to smoothstep is not actually a weight, and the decscription
of smoothstep was pretty hard to understand and easy to misinterpret.
Clarified what it means to be approximately equal.
nearest_po2 does not do what the descriptions says it does. For one,
it returns the same power if the input is a power of 2. Second, it
returns 0 if the input is negative or 0, while the smallest possible
integral power of 2 actually is 1 (2^0 = 1). Due to the implementation
and how it is used in a lot of places, it does not seem wise to change
such a core function however, and I decided it is better to alter the
description of the built-in.
Added a few examples/clarifications/edge-cases.
2020-07-25 20:26:02 +02:00
83e324d670
Update core documentation to match recent C# changes
...
Also a few minor API changes like adding AABB.abs()
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-07-21 14:44:53 -04:00
13298ed873
Improve the preload and load descriptions
2020-06-28 20:51:46 +02:00
540156b387
[Core] Rename linear_interpolate to lerp
2020-04-29 04:02:49 -04:00
0ef8bcac4d
DocData: Skip unexposed classes
...
Properly expose classes that we actually want accessible.
2020-04-20 12:51:10 +02:00
4c3c73ef9c
Add missing docs for assert message in GDScript
...
Seems like this was overlooked in PR #31142 . See also issue #17082 .
2020-03-31 19:56:44 +02:00
eaaee63b62
doc: Update classref with node renames
...
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
807b511125
Merge pull request #36620 from Calinou/doc-linear2db-example
...
Add a practical example for `@GDScript.linear2db()`
2020-02-28 07:03:35 +01:00
a6fd6b78dd
Add a practical example for `@GDScript.linear2db()`
...
One of its most common applications in games is for volume sliders.
See https://www.dr-lex.be/info-stuff/volumecontrols.html for
more information.
2020-02-27 22:52:21 +01:00
6b5573700b
Improve the `@GDScript.inverse_lerp()` documentation
...
This closes https://github.com/godotengine/godot-docs/issues/2589 .
2020-02-27 22:49:05 +01:00
213a85521d
doc: Sync classref with current source
...
Handle removal of Pool*Array types and other recent changes.
2020-02-18 14:02:02 +01:00
bd78b9f445
Remove deprecated decimals builtin
...
Replaced by 'step_decimals' in 3.2 via #21425 .
2020-02-12 13:39:39 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property
...
doc: Drop unused 'category' property from header
2020-01-26 16:34:13 +01:00
09ced94dd4
doc: Do not expose Variant::NIL as a type in the class reference
...
Fix signals Variant arguments incorrectly listed as Nil.
Fixes #12520 .
2020-01-26 16:08:11 +01:00
2d20fc39aa
doc: Drop unused 'category' property from header
...
We already removed it from the online docs with #35132 .
Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.
We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
cbdbfb00ca
doc: Document named color constants
...
Busywork but it's good for our completion rate :)
2020-01-26 12:08:16 +01:00
74977277fa
Merge pull request #34280 from zaksnet/fix-yield-documentation
...
Fix documentation for yield
2019-12-16 08:49:32 +01:00
468fcd80bb
Updates docs for GDScript built-in functions
...
* Adds description for `ord()`
* Adds relationship description between `char()` and `ord()`
* Describes the argument of `char()` as Unicode code point instead of ASCII code
* Fixes wrong interval notation in `randi()` description
2019-12-15 19:06:29 +08:00
0fd7186971
Fix documentation for yield
...
#33872 PR was misleading as i though inheritance from GDScriptFunctionState was optional.
2019-12-13 11:17:12 +02:00
6cc3bb2d9b
Add note in 'load()' docs that the path must be absolute
2019-12-11 17:14:58 -03:00
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
1fcdeaee39
Mention that `int()` can be used as an alternative to `floor()`
2019-12-03 08:43:24 +01:00
3231fca934
Add docs for is_equal_approx on structures
2019-11-30 16:52:27 -05:00
d747c61187
Fixed typo in docs for Script and GDScript classes ("exends" -> "extends")
2019-11-30 21:16:11 +03:00
Rémi Verschelde
Hugo Locurcio
Lightning_A
Heikki Simojoki
Marcel Admiraal
skyace65
Danil Alexeev
George Marques
Yuri Roubinsky
Serhat
Andrii Doroshenko (Xrayez)
Meriipu
Aaron Franke
Tomasz Chabora
Thomas ten Cate
clayjohn
Haoyu Qiu
Zak
Michael Alexsander
miere43