e53a5f6be5
Improve the Dictionary class documentation
...
- Mention Lua-style syntax.
- Make the code samples self-contained.
- Mention caveat with `const` (also in Array).
- Clarify the description of `size()`.
This closes https://github.com/godotengine/godot-docs/issues/4272 .
(cherry picked from commit 5325de4e6b
2020-11-17 12:07:02 +01:00
a57b6eb211
doc: Sync classref with current source
...
Move EditorSceneImporterFBX doc to its module folder.
2020-11-11 17:00:41 +01:00
98774000e2
Add append_array() method to Array class
...
(cherry picked from commit 9f23a94b8a
2020-11-11 15:44:14 +01:00
e07ac3d77e
Fix a typo in the Array class documentation
...
This closes https://github.com/godotengine/godot-docs/issues/4049 .
(cherry picked from commit 603eddce86
2020-09-24 14:43:07 +02:00
74952764f3
Improve documentation related to Array error handling
...
This closes https://github.com/godotengine/godot-docs/issues/3834 .
(cherry picked from commit 263f620421
2020-09-10 12:04:07 +02:00
f592600ee8
Mention that Array.front/back throw error if empty
...
(cherry picked from commit 4ff1a34171
2020-08-14 00:32:05 +02:00
b40f3f9740
Style: Sync other changes from new fix_style.sh and clang_format.sh
2020-07-24 10:39:18 +02:00
5a1f94ba47
Document the `in` operator in String, Array and Dictionary classes
...
This also clarifies the `in` operator behavior in Object.
(cherry picked from commit 7f01f68226
2020-06-15 14:34:34 +02:00
8ebcdeb3d7
Document that Dictionary is always passed as reference
...
See #38792 .
(cherry picked from commit 675fea1648
2020-05-18 16:40:33 +02:00
df2a2ae0fc
DocData: Fix serialization of Variant default values
...
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
(cherry picked from commit 788765709d
2020-03-09 11:36:57 +01:00
1191766609
doc: Mention concatenation using the `+` operator in Array
...
This closes https://github.com/godotengine/godot-docs/issues/2452 .
(cherry picked from commit 8d53562954
2020-03-04 12:40:15 +01:00
47368f2b7c
doc: Add an example for `Array.sort()`
...
This may help people understand the difference between alphabetical
and natural order more quickly.
(cherry picked from commit 1de9118c5f
2020-02-06 13:02:08 +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
c4745c96d7
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 14:41:49 -03:00
05bbbb1225
sort_custom description and example updated
2020-01-10 12:24:49 -06:00
e002044761
Be more specific about array return values.
...
The prior docs weren't clear if {pop_,}{front,back} would fail or return
`null` on an empty array.
2019-12-22 14:38:10 -05:00
52e799b6d4
Code format for true/false/null to make documentation consistent
2019-11-02 12:14:15 +01:00
4f294b958f
doc: Sync classref with current source
...
Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:52:06 +02:00
757c509437
Add array slice method
2019-09-14 13:08:28 -07:00
f7f6115f76
Proofread and improve the whole class reference
...
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
d02ecd5a18
updated description of Array.shuffle to properly describe that it uses the same common seed at every runtime, thus being reproducible in general
2019-05-11 18:04:47 -04:00
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
08c3a2241d
[DOCS] Minor classref updates.
2019-02-24 20:30:26 -08:00
e588c24168
doc: Fix formatting in code blocks
2018-12-14 09:37:19 +01:00
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
cfb54df986
Fix mistake in Array.xml
2018-09-10 13:42:45 +02:00
f92b87e5f8
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:41:14 +02:00
5267099a87
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
79ab43299a
Small doc formating changes and Linux cursor theme note
2018-08-05 04:07:04 -03:00
adb16be6b9
Doc: Add example for array indexing
...
Supersedes and closes #20180 .
2018-07-17 11:47:27 +02:00
9115d84913
[DOCS] Array sort
2018-05-25 16:55:56 +02:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
3fa77b3172
doc: Remove status from hardcoded version string
...
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
eb63f7b071
[DOCS] Sync classref with current source
2018-02-25 15:14:25 +07:00
37a6ce5a42
Merge pull request #15563 from poke1024/gdscript-shuffle
...
Add shuffle() method to Array
2018-02-19 21:53:08 +01:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
d516aab8fa
doc: Sync with current source
...
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
75d69fb4ec
Add shuffle() method to Array
2018-01-10 19:36:53 +01:00
9ab59343f4
Added example for Array sort_custom function
2017-12-08 18:06:45 -06:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
15ada56d73
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
d6e54de502
Add bsearch and bsearch_custom to Array
2017-11-21 08:50:31 +01:00
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
2fce0010f0
classref: Sync with current source
...
[ci skip]
2017-11-13 09:25:53 +01:00
b1f2c31a36
doc: Sync classref with current source
...
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
1d8a546a07
Merge pull request #11919 from Toizi/array_sort_ref
...
Array::sort/invert now return reference to Array
2017-10-10 20:31:48 +02:00
Hugo Locurcio
Rémi Verschelde
Tomasz Chabora
Michael Alexsander
cajallen
Ryan Roden-Corrent
PouleyKetchoupp
Cameron Reikes
hbina085
Chris Bradfield
LikeLakers2
VirtualBox
Max Hilbrunner
Poommetee Ketson
poke1024
Ralph Minderhoud
Andreas Haas