Commit Graph
816 Commits
Author SHA1 Message Date
Danil Alexeev 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check 2025-07-25 16:20:16 -04:00
Leandro (cerberus1746) Benedet Garcia 97f5aad069 Added tags and updated doc 2025-07-22 12:29:23 -03: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 29e83d3863 Merge pull request #11059 from Zshandi/patch-2
Update resources.rst to make inner class note more clear
2025-07-18 21:14:17 -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 768aa536ca Merge pull request #10920 from Athenr/master
Clarify UTF encoding between C# strings and Godot Strings
2025-07-18 07:50:20 -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
Zshandi Krahn 6e9342991d Update resources.rst to make inner class note more clear
The term "subclass" is often used as a synonym for "child class", so using it here to refer to an inner class is just confusing, even with the "i.e. an inner class" part. The GDScript Reference page simply uses the term "inner class" and never refers to them as "subclass", so this is also consistent with that.
2025-06-26 23:42:45 -07: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
nicolanore b8867b0817 Fix example code block for custom resources 2025-06-02 21:35:15 +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
AthenrandA Thousand Ships 55f2cf1509 Update tutorials/scripting/c_sharp/c_sharp_differences.rst
Revising for grammatical fixes in changes.

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2025-05-03 20:47:16 -04:00
Athenr 9d0fcf1288 Update c_sharp_differences.rst with C# string and Godot String UTF encoding
Clarified that C# System.String uses UTF-16 encoding while Godot String uses UTF-32.
2025-05-02 16:14:26 -04:00
David Snopek a7815c997e Stop referring to GDExtension as experimental 2025-05-02 10:49:34 -05:00
Max Hilbrunner 8db2f3ed62 Merge pull request #10631 from Ivorforce/godot-cpp-up
Split C++ (godot-cpp) and GDExtension system info into separate categories, children of Scripting.
2025-05-02 08:28:30 +02:00
Muller-Castro c8583abde8 Add _CLASS_SNAKE_CASE_ script template placeholder 2025-04-28 13:00:02 -03:00
Hugo Locurcio 6c3cef80b3 Document typed dictionaries in GDScript 2025-04-26 18:33:00 +02:00
Lukas Tenbrink 028abe15d1 Split C++ (godot-cpp) and GDExtension system info into separate categories, children of Scripting. 2025-04-24 21:59:02 +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
Hugo Locurcio c737b30d5d Mention the lack of debugger support in Running code in the editor 2025-04-22 14:38:51 +02:00
Matthew 28958a702c Merge pull request #10756 from Repiteo/style/pragma-once
Style: Integrate new `#pragma once` syntax
2025-04-15 19:09:39 -04: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
j4d3blooded fb1f3c8377 Included note about requirement for class_name for a resource to show… (#10838)
* Included note about requirement for class_name for a resource to show up in create resource GUI
2025-04-11 11:34:16 -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
starsJulyandtetrapod 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 042e68e3db Merge pull request #10847 from hewplayfair/patch-1
Clarify resources.rst
2025-04-09 09:46:48 -04:00
Matthew 16f672ee04 Merge pull request #10724 from dresswithpockets/patch-1
Add Odin binding to community GDExtension binding list
2025-04-08 21:27:33 -04:00
Matthew 7bc1c2b15e Merge pull request #10846 from raulsntos/dotnet/bits-defines
C#: Remove outdated bits defines
2025-04-08 17:36:19 -04:00
Hew Playfair dc5ef25815 Clarify resources.rst
The description of how to save a Resource in the Inspector refers to a menu that doesn't exist in 4.4 stable.
2025-04-08 15:39:26 -04:00
Raul Santos 1d103b1a23 C#: Remove outdated bits defines
These defines were removed in 4.0 but we missed them when we previously updated this documentation page.
2025-04-08 20:13:14 +02:00
Matthew 8343a181d5 Merge pull request #10832 from DeerUwU/patch-1
Fix Export Enum Example in c_sharp_exports.rst ( Line 458)
2025-04-06 19:33:36 -04:00
Matthew 1335f389ec Merge pull request #10781 from Lexyth/patch-3
Clarify type-safety of as
2025-04-06 19:29:18 -04:00
Deer ♡ d3794505f0 Update c_sharp_exports.rst
changed line 458:
    public MyEnum MyEnum { get; set; }
to:
    public MyEnum MyEnumCurrent { get; set; }

because it throws an error if you reuse the already declared name
2025-04-03 19:19:01 +02:00
Hugo Locurcio 949cf045f0 Document @export_tool_button icon parameter in GDScript exports 2025-04-01 01:41:40 +02:00
Matthew 2ec67ebd43 Merge pull request #10782 from Lexyth/patch-4
Fix misplaced bad example
2025-03-26 12:50:56 -04:00
Austin Almond 1966e9a844 Update gdextension_c_example.rst 2025-03-23 19:22:05 -04:00
LexythandA Thousand Ships 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
LexythandDanil Alexeev 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