godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-01 21:48:57 +03:00
Code Issues Packages Projects Releases Wiki Activity
10,494 Commits 20 Branches 0 Tags
0e38251f80e2bdc028e17c8353c2cd400a071a67
Commit Graph

797 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
Thaddeus Crews
da33f97e63 Style: Integrate new #pragma once syntax 2025-03-10 09:56:48 -05:00
Matthew
ce2a1b54c9 Merge pull request #10741 from RazerTexz/patch-1 
String.format() wrong placeholder syntax
 2025-03-05 17:56:33 -05:00
reisnersteve
7bf735d38b Update c_sharp_basics.rst (MonoDevelop has been abandoned) 
MonoDevelop has officially been retired 4 years ago on github (https://github.com/mono/monodevelop)
 2025-03-04 13:07:49 +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
Ashley
ba65fc75d8 Add Odin binding to community binding list 
Signed-off-by: dresswithpockets <dresswithpockets@pm.me>
 2025-02-27 17:56:35 -07:00
tetrapod
6361c66aa3 Merge pull request #10711 from raulsntos/dotnet/export-tool-diagnostics 
C#: Document `[ExportToolButton]` diagnostics
 2025-02-26 12:42:18 -08:00
Raul Santos
662a055a66 C#: Document [ExportToolButton] diagnostics 2025-02-23 04:45:06 +01: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
Hugo Locurcio
8d9085ae7c Add guidelines on inline comments in GDScript style guide (#9433) 
* Add guidelines on inline comments in GDScript style guide
 2025-02-15 23:03:26 -05:00
tetrapod00
6902e58d09 Reorder Output panel message categories to match order in editor 2025-02-15 18:28:54 -08:00
Harry Keightley
126dcf1b6d Switch ordering of *error* and *warning* in debug docs. 
Error and Warning were incorrectly given each-other's descriptions. This change switches the sub-titles for each section.
 2025-02-16 10:59:39 +09: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
6311520290 Document limitation of Visual Profiler on macOS 2025-02-12 00:31:40 -08: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
Rémi Verschelde
ffac3a0408 GDExtension: Fix typo on compatibility_minimum property 2025-02-07 13:25:14 +01:00
Vojtech Krajnansky
4421c6226c Update binding Signal connection args docs 2025-02-06 18:34:43 +01:00