godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
10,528 Commits 20 Branches 0 Tags
7a7ac7dc2d24eca3bb38df7d26cd351ebd36cb09
Commit Graph

296 Commits

Author SHA1 Message Date
Danil Alexeev
7a7ac7dc2d GDScript: Document abstract and variadic functions 2025-06-24 10:25:49 +03: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
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
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
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
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
Emily
99b1f86d53 Update list of advantages and disadvantages to more accurately refle… (#8736) 
* Updated list of advantages and disadvantages
 2025-01-25 15:15:26 -05:00
Martin Beaussart
d18c89ba71 Update code order with static annotation on gdscript_styleguide.rst (#8920) 
* Update code order with static annotation on gdscript_styleguide.rst

Update code order on gdscript_styleguide.rst
by inserting static variables and methods on the code order as a proposal
 2025-01-25 12:06:20 -05:00
Billy Guzik
42ac7c8431 Update gdscript_exports.rst (#9327) 
* Update gdscript_exports.rst

Added hyperlinks for each export type that lead to annotation documentation further explaining each export type, as requested in issue#9281
 2025-01-25 11:32:33 -05:00
tetrapod00
8d1a93f2ff Add links from GDScript keywords table to relevant sections 2025-01-21 15:29:51 -08:00
Hugo Locurcio
265397c5fc Add @icon ordering to the GDScript style guide 2025-01-13 17:25:42 +01: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
Danil Alexeev
d610bfdf23 GDScript: Document @warning_ignore_start and @warning_ignore_restore 2024-12-23 23:58:46 +03:00
Max Hilbrunner
47d39d9048 Merge pull request #10413 from tetrapod00/be-nice-to-c 
Rephrase dictionary description in Advanced GDScript
 2024-12-16 19:11:59 +01:00
tetrapod00
fdfa3ea66e Rephrase dictionary description in Advanced GDScript 2024-12-15 13:58:40 -08:00
tetrapod00
bd25f5813a Simply remove some words 2024-12-14 20:36:17 -08:00
Hugo Locurcio
806a4fccfd Add a page on the Output bottom panel 2024-12-07 08:40:44 +01:00
52SW
e05cebecdb Document GDScript @export_tool_button (#10338) 
* Add @export_tool_button to the documention
 2024-11-29 15:18:08 -05: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
tetrapod00
c1310e6009 Add GDScript naming convention summary table 
Co-Authored-By: Edwin <60202421+emarino135@users.noreply.github.com>
Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
 2024-11-20 14:40:36 -08:00
tetrapod00
09156f2ee9 Add UPDATE comments to perishable information 2024-11-17 13:50:42 -08:00
Max Hilbrunner
9a886ec4af Merge pull request #10276 from mhilbrunner/cherry-pick-10242 
Cherrypick #10242 (Add info about layer mask exporting to physics_introduction) to master
 2024-11-17 11:36:07 +01:00
Max Hilbrunner
ff46ea4407 Merge pull request #9777 from 0stam/is-not-conversion 
Use the newly introduced ``is not`` operator
 2024-11-17 11:34:55 +01:00
notPelf
00221436f4 Add info about layer mask exporting to physics_introduction.rst (#10242) 
* Update physics_introduction.rst

The docs page for raycasting provides a link to the physics introduction page for how to set a collision mask on a raycast created in code. The physics introduction page does not mention export annotations for exporting a collision mask. This pull request adds a brief bit about exporting layer masks, and links to the export annotation docs.

---------

Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
 2024-11-17 11:30:23 +01:00
Hugo Locurcio
4c3020b775 Document @export_custom and additional range hints in GDScript exports 
This also adds a hint suffix example to C# exports.

Co-authored-by: Shawn Hardern <126725649+ShawnHardern@users.noreply.github.com>
 2024-11-11 17:22:44 +01:00
Max Hilbrunner
396fc8fd08 Merge pull request #10227 from tetrapod00/integral-integer 
Improve GDScript format strings tutorial
 2024-11-08 00:18:03 +01:00
tetrapod00
5606be5c75 Improve GDScript format strings tutorial 
Remove usages of "integral".
Add section on string concatenation.
Improve organization.
Fix incorrect examples.
 2024-11-07 14:45:21 -08:00
tetrapod00
5994348764 Change all usages of "run-time" to "runtime" 2024-11-06 23:36:58 -08:00