154 Commits

Author SHA1 Message Date
Max Hilbrunner
46a8e010ca GDScript: Clarify the use of callv() to call variadic functions (#11501) 2025-12-19 11:42:35 +01:00
Danil Alexeev
ed5bc5ebc7 GDScript: Clarify the use of callv() to call variadic functions 2025-11-27 16:33:55 +03:00
Alexander Morland
b5965dddcd fixed indentation causing render issue on code sample
bad indentation causing render error if this code sample
2025-11-24 16:31:37 +01:00
Hugo Locurcio
2481589819 Document function parameter defaults in GDScript reference
This also fixes some reStructuredText syntax issues.
2025-10-14 23:40:37 +02:00
Hugo Locurcio
b3cbe5f777 Remove old Godot version references to simplify documentation
This follows the documentation writing guidelines, specifically
the "When to refer to a specific Godot version" section.

This also removes warning blocks for a known issue that was resolved in Godot 4.5.
2025-10-07 19:01:12 +02:00
Danil Alexeev
3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check 2025-07-25 16:20:16 -04:00
Matthew
3f65fd4614 Merge pull request #10888 from Calinou/running-code-in-the-editor-static-context
Clarify rules around which scripts require `@tool` in Running code in the editor
2025-07-18 07:54:13 -04:00
Matthew
ba34190d15 Merge pull request #11029 from dalexeev/gds-abstract-and-variadic-funcs
GDScript: Document abstract and variadic functions
2025-06-28 12:49:49 -04:00
Danil Alexeev
7a7ac7dc2d GDScript: Document abstract and variadic functions 2025-06-24 10:25:49 +03:00
A Thousand Ships
92cd36b50e Various grammar and spelling fixes 2025-06-23 16:37:26 +02:00
Hugo Locurcio
8a6ad4c926 Replace uses of shorthand codeblock syntax to avoid issues with localization
Previously, many paragraphs in the documentation used `::` at the end of a line
as a replacement for a single colon (and `::` on the following line).
Due to this, the `::` was part of the extracted string for localization.
Weblate also showed a warning about the trailing `::`, as it's not
normally expected to be there.

This change requires translators to revalidate all modified strings.
However, considering many of those have broken code blocks due to translators
replacing `::` with `:`, it can be a good idea.

This also adds documentation writing guidelines for code blocks and admonitions.
This commit does not modify existing admonitions in any way (as this would
lead to a much larger diff, and require more localizable text to be revalidated
by translators).
2025-05-30 02:02:30 +02:00
Hugo Locurcio
db2bc419a3 Document abstract classes in GDScript 2025-05-14 01:31:02 +02:00
Hugo Locurcio
6c3cef80b3 Document typed dictionaries in GDScript 2025-04-26 18:33:00 +02:00
Hugo Locurcio
ab7c43c899 Clarify rules around which scripts require @tool in Running code in the editor
- Mention that static methods work, but not static variables.
- Emphasize the use of version control due to the lack of undo/redo.
2025-04-22 14:47:20 +02:00
Matthew
b12476f595 Merge pull request #10625 from Vocco/update-bound-signal-args
Update binding Signal connection args docs
2025-03-02 14:33:13 -05:00
Matthew
59a53252ec Merge pull request #10659 from tetrapod00/doc-not-toc
Update links to C# and GDScript sections
2025-02-22 08:13:44 -05:00
Thibault J.
70def630be Clarify the global registration of named_classes (#10679)
* Add a clarification about named class registry
2025-02-15 15:24:53 -05:00
tetrapod00
048bb2775e Update links to C# and GDScript sections
- Change all links to '_doc' anchors instead of 'toc's.
- Move 'doc_c_sharp' and 'doc_gdscript' to the index pages.
- Add 'doc_gdscript_reference' anchor.
- Update all existing links to point to the right place,
updating grammar if needed.
2025-02-09 16:16:43 -08:00
Vojtech Krajnansky
4421c6226c Update binding Signal connection args docs 2025-02-06 18:34:43 +01:00
Sai Nane
98ce9b570b Briefly document Vector<> variations
`Packed*Array` aliases seem universally preferred where available, so
a link to the list of types seems appropriate.

`LocalVector` is used sparingly, so mentioning the intent and rough
tradeoff involved seems right for an overview.
2025-01-29 12:20:45 +00:00
tetrapod00
8d1a93f2ff Add links from GDScript keywords table to relevant sections 2025-01-21 15:29:51 -08:00
Amaral Krichman
65da706a85 Update gdscript_basics.rst 2025-01-03 00:19:39 -03:00
lena
63cec69b30 Add a paragraph about self (#8928)
Adds a paragraph about the self keyword and documents that
it can be used to refer to variables defined in subclasses of
current class.

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: RedMser <5117197+RedMser@users.noreply.github.com>
Co-authored-by: Danil Alexeev <dalexeev12@yandex.ru>
Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2024-12-26 15:30:42 -08:00
Quinn
6292c86298 Replace mentions of Reference with RefCounted 2024-11-29 22:13:27 +10:00
mechalynx
0f8c24b071 Update PackedArray explanation to match Godot 4.0 behavior (#10304)
Add paragraphs describing the differences between PackedArray and
normal or typed Array.

---------

Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2024-11-22 10:03:47 +01:00
Max Hilbrunner
cc48adbf4e Merge pull request #10080 from tetrapod00/gdscript-sidebar
Improve GDScript Basics sidebar navigation by changing header levels
2024-10-28 23:22:36 +01:00
Max Hilbrunner
8d28f0fc82 Merge pull request #10097 from Calinou/gdscript-basics-documentation-comments
Mention documentation comments in GDScript basics
2024-10-18 05:33:23 +02:00
Hugo Locurcio
cbf61b3f02 Document Variant not being nullable 2024-10-17 15:28:24 +02:00
Hugo Locurcio
594a1d6cbc Mention documentation comments in GDScript basics 2024-10-17 15:12:35 +02:00
tetrapod00
4a24e7553b Improve GDScript Basics sidebar navigation by changing header levels
Promotes many headers up one level, so they appear in the sidebar.
Removes the redundant Language header, since the whole page is about the language.
2024-10-13 13:30:41 -07:00
Junwan Park
e01a998069 Fix builtin_types link in tutorial gdscript_basics page
It's linked to a wrong position.
2024-09-27 01:43:04 +09:00
Hugo Locurcio
4726e131db Document PackedVector4Array
This type was added in Godot 4.3.
2024-09-02 22:21:50 +02:00
A Thousand Ships
0686612e82 [GDScript] Clarify initialization of enum values 2024-08-31 14:41:33 +02:00
Max Hilbrunner
ff66473d3d Merge pull request #9787 from tetrapod00/gdscript-when
Document GDScript "when" and clarify pattern guard docs
2024-08-29 21:38:01 +02:00
tetrapod00
443d5e9be5 Add documentation for GDScript when statement 2024-08-26 09:39:41 -07:00
MajorGonzo
1d05bdd9f1 Corrected typo in gdscript_basics.rst
beging -> begin
2024-08-20 08:38:57 -05:00
DDoop
e9035f7cf0 Add warnings for classes named "Editor" in GDscript and C# pages, class_name keyword/global class attribute (#9548)
* Added warning about Editor hiding class_names beginning with Editor prefix

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-08-14 19:42:36 +02:00
Muller-Castro
a36ff907f9 Add typed loop variable example in GDScript reference (#9388) 2024-08-02 02:30:20 +02:00
Danil Alexeev
67be15e905 GDScript: Update lambda documentation 2024-06-29 14:51:46 +03:00
Hana - Piralein
3e2a8f6f7c Update outdated annotation and setget syntax
Co-Authored-By: PoolloverNathan <24194027+PoolloverNathan@users.noreply.github.com>
Co-Authored-By: Solor Vox <1246172+solorvox@users.noreply.github.com>
2024-06-27 22:13:37 +02:00
Hakunamawatta
eb14a4adae Typo in gdscript_basics.rst 2024-06-19 22:32:32 +10:00
A Thousand Ships
36e2351df2 Fix invalid indentation in various files 2024-06-06 16:16:45 +02:00
CJ Brown
7b91dffc22 Remove Note from Constants
PR #71051
Documentation not updated to reflect deep read-only change to const Array and const Dictionary
2024-05-21 14:37:23 -04:00
Yuri Rubinsky
3e05334189 Add a super keyword to the table of keywords 2024-05-02 18:35:10 +03:00
Max Hilbrunner
160034a4ac Merge pull request #9188 from allenwp/annotation-improvements
Improve description of annotations
2024-04-30 04:19:10 +02:00
Allen Pestaluky
8dd09aa962 Improved description of annotations
Removes an unnecessary and potentially confusing comparison of annotations to keywords and generally improves wording in the GDScript Basics tutorial. A new page to the Contributing section has been added for scripting development guidelines. This new page hosts suggestions on when annotations should be implemented in GDScript.
2024-04-29 13:18:30 -04:00
NormPlum
94b33fc106 Update gdscript_basics.rst
Fix grammar re. 'await/awaiting'.
2024-04-27 03:13:09 +00:00
JP
4ae3064699 Fixed out of date binding syntax for Signal.connect
fixes godotengine/godot-docs#9236
2024-04-23 13:33:09 +02:00
Danil Alexeev
60befd7527 GDScript: Clarify raw string literals documentation 2024-04-09 16:25:03 +03:00
lena
2925c83390 docs: Clarify associativity of operators. (#9170)
* docs: Clarify associativity of operators.
2024-04-06 19:28:25 +02:00