325 Commits

Author SHA1 Message Date
Max Hilbrunner f563718ac4 Merge pull request #11934 from andyprice/abstract_class_fix
GDScript reference: Fix inconsistency in an abstract class example
2026-05-03 10:07:09 +02:00
Matthew c81428cd0c Merge pull request #11883 from nicolasiensen/remove-node-dock-references
Remove references to Node dock
2026-05-03 10:06:09 +02:00
Matthew def223e281 Merge pull request #9903 from AdriaandeJongh/export-loads-resources
Explain that `@export` loads `Resource`s when script instances are loaded
2026-05-03 10:03:55 +02:00
WraithGlade f0d6c52ab0 Fixed minor typo: missing subject noun ("the script").
This sentence was missing the proper subject of the verb and was slightly grammatically off.
2026-01-25 13:57:38 -05:00
Phlegm 78d655b41b Merge pull request #11356 from Phlegmlee/patch-2
Update gdscript_exports.rst - Add info on how to create property descriptions
2026-01-22 11:07:46 +01:00
Max Hilbrunner 6222cd617d Merge pull request #11070 from dalexeev/gds-update-annotation-desc-and-guidelines
GDScript: Update annotation description and development guidelines
2026-01-18 14:33:27 +01:00
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
wk-y 67ce5abf2b Change 'subclasses' to 'inner classes' in style guide 2025-11-12 15:55:52 -08:00
Hugo Locurcio 229d02c146 Document reading an exported property value's early on in GDScript exports 2025-11-04 18:19:06 +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
Max Hilbrunner f6b40a054e Merge pull request #11352 from Calinou/remove-old-version-references
Remove old Godot version references to simplify documentation
2025-10-11 12:45:38 +02:00
notroid5 cf795af4f8 Update static_typing.rst
Fixed missing new line
2025-10-08 11:39:42 +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 228234f43e GDScript: Update annotation description and development guidelines 2025-10-01 14:10:17 +03:00
Hugo Locurcio f3fd393817 Document global scope methods in Static typing in GDScript 2025-09-18 00:43:48 +02:00
Hugo Locurcio 0b03cc70ed Clarify assignment operator in typed array/dictionary documentation 2025-08-26 18:45:48 +02:00
Danil Alexeev 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check 2025-07-25 16:20:16 -04:00
Matthew ff29de0d89 Merge pull request #9980 from HolonProduction/editable-clearup
Clearify behaviour of `@export` in combination with setters
2025-07-18 21:20:31 -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
Ayush Raj 2cbf133533 fixed issue 11090 2025-07-07 20:48:57 +00:00
Dipl.-Ing. Dr. Markus Weninger, BSc 15912feec0 Update static_typing.rst
The documentations said it shows the same callback two times, one time with dynamic typing and one time with type hints. In reality, two different callbacks were shown. This has been fixed.
2025-06-28 21:25:45 +02: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
Matthew 7e591554a2 Merge pull request #10823 from Calinou/gdscript-exports-tool-button-icon
Document `@export_tool_button` icon parameter in GDScript exports
2025-06-27 14:31:22 -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
HolonProduction b26724f1b4 Clearify behaviour of @export in combination with setters 2025-06-16 23:47:57 +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
ProgrammerOnCoffee 73688d34d8 Fix typos in warning system documentation images (#10849)
* Fix warning system image typos
2025-04-14 23:39:55 +02:00
Matthew 8c18714228 Merge pull request #10780 from Lexyth/patch-2
Update Enum names, improve enum member names, and add related suggestion
2025-04-11 11:59:57 -04:00
lena f31a4ac23f docs: Add a note about the effect of @export. (#10560)
Add information on @export and RPC.
2025-04-11 10:42:19 -04:00
starsJuly 2f4ad61ef6 Update the @export_custom example in gdscript_exports.rst
Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2025-04-11 11:01:50 +08:00
starsJuly ab6e73822a Fix @export_custom hint format in gdscript_exports.rst 2025-04-10 21:23:44 +08:00
Matthew 1335f389ec Merge pull request #10781 from Lexyth/patch-3
Clarify type-safety of as
2025-04-06 19:29:18 -04:00
Hugo Locurcio 949cf045f0 Document @export_tool_button icon parameter in GDScript exports 2025-04-01 01:41:40 +02:00
Lexyth 571a85decf Update line length
Reduced the line length to make it more readable.

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2025-03-23 15:21:15 +01:00
Lexyth 8609443a5b Update format
Used code-block format for "null" keyword.

Co-authored-by: Danil Alexeev <dalexeev12@yandex.ru>
2025-03-23 11:15:29 +01:00
Lexyth 4b04e656cd Remove Good example title from as keyword example
Removed Good example title from the example for the "as" keyword, as it is a neutral example.
2025-03-23 11:11:58 +01:00
Lexyth 014031046a Fix good/bad example order
Moved the bad example below the good example to stay consistent with previous instances.
2025-03-23 11:08:24 +01:00
Lexyth 58c9fdb6b5 Clarify null-safety vs type-safety
Changed the statement about the "as" keyword to clarify that it affects null-safety, not type-safety.
2025-03-23 10:28:47 +01:00
Lexyth 5a46a02f4b Fix misplaced bad example
Moved the bad example for the inferred type for functions that return super types directly after its related statement.
2025-03-19 00:42:37 +01:00
Lexyth 7b7952ae71 Clarify type-safety of as
Changed the statement about the as keyword's type-safety to clarify that it is less type-safe than type hints.
2025-03-19 00:37:10 +01:00
Lexyth 49b3281d13 Update Enum names, improve enum member names, and add related suggestion
- Changed the grammatical number of all enum names to be singular.
- Removed the enum names from their members, (e.g.: Tile.TILE_BRICK -> Tile.BRICK).
- Added a suggestion for the reader to use singular case for enum names.
2025-03-19 00:09:04 +01:00
RazerTexz 820fdbe6b7 String.format() wrong placeholder syntax
From: `var string = "I have {} cats.".format([3])`
To: `var string = "I have {0} cats.".format([3])`
2025-03-04 11:21:22 +05: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