198 Commits

Author SHA1 Message Date
CJ Brown
3f17911d77 Remove Note from Constants
PR #71051
Documentation not updated to reflect deep read-only change to const Array and const Dictionary

(cherry picked from commit 7b91dffc22)
2024-07-24 21:05:41 +02:00
Hugo Locurcio
4aafc5ac67 Tweak guidelines on dictionary and enum formatting in GDScript style guide
- Recommend writing each enum item on its own line, similar to C++.
- Recommend using spaces around inline dictionary declarations
  to make them easier to distinguish from arrays (due to similar-looking
  `[]` and `{}` characters in most fonts). This is commonly found
  in Python or JavaScript style guides.

(cherry picked from commit 71cdbdd055)
2024-07-24 21:04:48 +02:00
NormPlum
ae38bfc90c Update gdscript_basics.rst
Fix grammar re. 'await/awaiting'.

(cherry picked from commit 94b33fc106)
2024-07-24 21:01:05 +02:00
JP
66507f7267 Fixed out of date binding syntax for Signal.connect
fixes godotengine/godot-docs#9236

(cherry picked from commit 4ae3064699)
2024-07-24 20:59:22 +02:00
Danil Alexeev
f810e958d5 GDScript: Clarify raw string literals documentation
(cherry picked from commit 60befd7527)
2024-07-24 20:56:56 +02:00
lena
b8e65373cd docs: Clarify associativity of operators. (#9170)
* docs: Clarify associativity of operators.

(cherry picked from commit 2925c83390)
2024-07-24 20:55:51 +02:00
444B
7c85937f7b Update gdscript_styleguide.rst - clarified sentence and grammar (#9110)
* Update gdscript_styleguide.rst - clarified sentence and grammar

- Clarified the statement on "One statement per line"
- Removed unclear sentence with incorrect grammar

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
(cherry picked from commit 3d441150b1)
2024-07-24 20:52:32 +02:00
Max Hilbrunner
ae127b0802 Merge pull request #7507 from dalexeev/gds-var-init-order
GDScript: Document variable initialization order
2024-01-25 10:25:39 +01:00
Matthew
72100d77d4 Merge pull request #8809 from BWPanda/patch-1
Re-word 'Comment spacing' note in gdscript_styleguide.rst
2024-01-25 10:13:57 +01:00
Max Hilbrunner
525328c0c3 Merge pull request #8748 from Calinou/doc-importing-images-svg-text
Document importing SVG images with text
2024-01-25 10:11:05 +01:00
Max Hilbrunner
42035c7796 Merge pull request #8730 from Marenz/patch-1
Lambdas need an explicit `return`
2024-01-25 10:10:18 +01:00
Max Hilbrunner
2b3bc6d530 Merge pull request #8654 from AdriaandeJongh/patch-3
Added section on common unsafe operations and their safe counterparts
2024-01-25 10:10:12 +01:00
Max Hilbrunner
1b5a1a2f59 Merge pull request #8615 from TheYellowArchitect/patch-13
Slight polish at enum example
2024-01-25 09:53:54 +01:00
Phlegmlee
5951d5850d Removed duplicate line.
The line below is redundant, it exits on line 141 - 142 and therefore isn't needed on 159.

 ## The description of a constant.
    const GRAVITY = 9.8
2024-01-25 09:43:34 +01:00
TheYellowArchitect
ee4eae3208 Added enum iteration example 2024-01-25 09:38:49 +01:00
oujionghong
c925bcd76f Fixing guide example on 2 indent levels for continuation lines
The original example seems to be using 3 tabs for indentation, but the description said 2 should be used.
2023-11-17 10:16:32 +08:00
Max Hilbrunner
31063027c8 Merge pull request #7579 from dalexeev/gds-setter-getter-doc
GDScript: Clarify setter/getter documentation
2023-11-11 02:26:01 +01:00
Max Hilbrunner
85fc55a922 Merge pull request #8250 from rarysson/update-warning-system
Update GDScript warning system to use `@warning_ignore`
2023-11-10 22:33:44 +01:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Rarysson Guilherme
49133c0e5c Update GDScript warning system to use @warning_ignore 2023-11-10 11:33:27 -03:00
Byemoh
46c743ae37 Update gdscript_basics.rst 2023-11-08 18:44:05 -06:00
Matthew
d2c5133674 Merge pull request #8136 from Hex-4/fix-scripting-advanced-settings
fix #8076, update image and remove note in GDScript warning system docs
2023-11-08 18:30:14 -05:00
Hex-4
eabd668cb7 fix #8076, update note in gdscript warning system settings page 2023-11-07 23:35:02 +00:00
Hugo Locurcio
54331c3c8f Document support for code folding regions in GDScript reference 2023-11-06 22:49:28 +01:00
Danil Alexeev
e1911e7355 Fix list of default comment marker keywords 2023-11-02 11:47:52 +03:00
Hugo Locurcio
0756294d3b Document comment keywords being highlighted in the script editor 2023-11-01 15:07:14 +01:00
Benedikt Ziemons
1beedb8ae8 Update GDScript reference, 'in'-keyword explanation
The explanation for the keyword 'in' states it checks, whether an element is in a list (among others). This is the only occurrence of the word 'list' in this context and I assume it actually means array. To avoid future confusion, it makes sense to replace the word list with array in this explanation.
2023-10-19 10:22:37 +02:00
Max Hilbrunner
85be0daece Merge pull request #7985 from dalexeev/update-gds-doc-comments-page
Update "GDScript documentation comments" page
2023-10-09 01:51:17 +02:00
nicolas-scarrci
c1a9c4dc73 Clarify class keyword usage (#7741)
* Clarify class keyword usage

* Added reference link for class_name as well

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-10-06 13:04:08 +02:00
Max Hilbrunner
17f0da6a53 Merge pull request #8130 from dalexeev/gds-update-static-typing
Update "Static typing in GDScript" page
2023-10-06 12:44:47 +02:00
Danil Alexeev
9eb7aa3f59 Update "Static typing in GDScript" page 2023-10-06 12:49:26 +03:00
Max Hilbrunner
97c0af67aa Merge pull request #8082 from bteixeira/patch-2
Update gdscript_format_string.rst
2023-10-06 01:44:51 +02:00
Danil Alexeev
6ad7f78001 GDScript: Update match patterns and literal docs 2023-10-05 19:18:05 +03:00
Max Hilbrunner
49ac573d24 Merge pull request #8094 from dalexeev/gds-add-match-pattern-guard-info
GDScript: Document `match` pattern guards
2023-10-04 18:57:54 +02:00
Yuri Sizov
ac728e8dd2 Update the state of C#/.NET support as of 4.2 2023-10-03 18:03:52 +02:00
Danil Alexeev
da3f1a1275 GDScript: Document match pattern guards 2023-09-29 14:28:44 +03:00
Bruno Teixeira
ebb36dc876 Update gdscript_format_string.rst
Added missing documentation for `%v` string formatting for vectors.
2023-09-28 15:11:37 +02:00
Elnar Dakeshov
4b6e15d3b3 Update style guide (#8038)
Used get instead of set.
2023-09-27 03:03:08 +02:00
Danil Alexeev
9aa85cee05 Update "GDScript documentation comments" page 2023-09-21 16:33:55 +03:00
Danil Alexeev
09d9d9a895 GDScript: Document raw string literals 2023-09-21 00:04:38 +03:00
Max Hilbrunner
64867d4341 Merge pull request #7812 from dalexeev/gds-mention-array-assign-method
GDScript: Mention `Array.assign()` method in typed arrays documentation
2023-09-10 20:12:38 +02:00
Hugo Locurcio
8e4f72f3f4 Mention typing of for loop variable in Static typing in GDScript 2023-08-21 19:44:52 +02:00
Danil Alexeev
34a620e2c2 GDScript: Mention Array.assign() method in typed arrays documentation 2023-08-16 11:30:39 +03:00
Danil Alexeev
60e3f14d98 Update "GDScript documentation comments" page 2023-08-01 11:52:42 +03:00
Aaron
81f1db2ca8 Fix the spelling and example list code. 2023-07-19 12:15:22 -04:00
Max Hilbrunner
df7068bf03 Merge pull request #7603 from dalexeev/gds-arrays 2023-07-18 17:06:50 +02:00
Max Hilbrunner
5dc2506ed8 Merge pull request #7591 from dalexeev/gds-warn-override-non-virtual 2023-07-18 13:41:05 +02:00
Ninni Pipping
1a1500cebe Fix outdated use of File in gdscript_basics 2023-07-17 16:22:30 +02:00
CactiChameleon9
cf5222b129 Fix mention of Godot3's or_lesser for export_range 2023-07-08 06:34:20 +01:00
Danil Alexeev
9fb9915ad9 GDScript: Document static variables 2023-07-03 14:58:23 +03:00