godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
9,401 Commits 20 Branches 0 Tags
4.3
Commit Graph

243 Commits

Author SHA1 Message Date
Danil Alexeev
c3322d8d27 GDScript: Document variable initialization order 2024-01-14 19:35:25 +03:00
Max Hilbrunner
01a7b2ff94 Merge pull request #7520 from Calinou/add-page-comments 
Add support for user-provided comments with Giscus
 2024-01-13 22:32:30 +01:00
Hugo Locurcio
95fb178429 Add support for user-provided comments with Giscus 
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
 2024-01-11 17:51:53 +01:00
Hugo Locurcio
e93fc9b1f2 Document importing SVG images with text 
- Mention editor plugins and custom node icons should use the appropriate
  import options.
 2024-01-11 00:18:50 +01:00
Max Hilbrunner
ed8a175d80 Merge pull request #8654 from AdriaandeJongh/patch-3 
Added section on common unsafe operations and their safe counterparts
 2024-01-08 07:57:29 +01:00
Mathias L. Baumann
d3ee49e2b7 Update tutorials/scripting/gdscript/gdscript_basics.rst 
Lambdas need an explicit `return`

Extend the documentation so that it is clear that lambdas require an explicit return .

Also add an according example.

Co-Authored-By: Danil Alexeev <danil@alexeev.xyz>
 2024-01-07 13:59:19 +01:00
Adriaan de Jongh
648388ecbd added section on common unsafe operations and their safe counterparts 2024-01-06 23:40:02 +01:00
The Yellow Architect
c01e958492 Corrected expected output in enum comments 2023-12-13 21:05:14 +02:00
TheYellowArchitect
795df857cb Added enum iteration example 2023-12-10 20:32:57 +02:00
Phlegmlee
d6eb215d19 Removed duplicate line. 
The line below is redundant, it exits on line 141 - 142 and therefore isn't needed on 159.

 ## The description of a constant.
    const GRAVITY = 9.8
 2023-12-05 14:36:50 -06:00
oujionghong
c925bcd76f Fixing guide example on 2 indent levels for continuation lines 
The original example seems to be using 3 tabs for indentation, but the description said 2 should be used.
 2023-11-17 10:16:32 +08:00
Max Hilbrunner
31063027c8 Merge pull request #7579 from dalexeev/gds-setter-getter-doc 
GDScript: Clarify setter/getter documentation
 2023-11-11 02:26:01 +01:00
Max Hilbrunner
85fc55a922 Merge pull request #8250 from rarysson/update-warning-system 
Update GDScript warning system to use `@warning_ignore`
 2023-11-10 22:33:44 +01:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Rarysson Guilherme
49133c0e5c Update GDScript warning system to use @warning_ignore 2023-11-10 11:33:27 -03:00
Byemoh
46c743ae37 Update gdscript_basics.rst 2023-11-08 18:44:05 -06:00
Matthew
d2c5133674 Merge pull request #8136 from Hex-4/fix-scripting-advanced-settings 
fix #8076, update image and remove note in GDScript warning system docs
 2023-11-08 18:30:14 -05:00
Hex-4
eabd668cb7 fix #8076, update note in gdscript warning system settings page 2023-11-07 23:35:02 +00:00
Hugo Locurcio
54331c3c8f Document support for code folding regions in GDScript reference 2023-11-06 22:49:28 +01:00
Danil Alexeev
e1911e7355 Fix list of default comment marker keywords 2023-11-02 11:47:52 +03:00
Hugo Locurcio
0756294d3b Document comment keywords being highlighted in the script editor 2023-11-01 15:07:14 +01:00
Benedikt Ziemons
1beedb8ae8 Update GDScript reference, 'in'-keyword explanation 
The explanation for the keyword 'in' states it checks, whether an element is in a list (among others). This is the only occurrence of the word 'list' in this context and I assume it actually means array. To avoid future confusion, it makes sense to replace the word list with array in this explanation.
 2023-10-19 10:22:37 +02:00
Max Hilbrunner
85be0daece Merge pull request #7985 from dalexeev/update-gds-doc-comments-page 
Update "GDScript documentation comments" page
 2023-10-09 01:51:17 +02:00
nicolas-scarrci
c1a9c4dc73 Clarify class keyword usage (#7741) 
* Clarify class keyword usage

* Added reference link for class_name as well

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
 2023-10-06 13:04:08 +02:00
Max Hilbrunner
17f0da6a53 Merge pull request #8130 from dalexeev/gds-update-static-typing 
Update "Static typing in GDScript" page
 2023-10-06 12:44:47 +02:00
Danil Alexeev
9eb7aa3f59 Update "Static typing in GDScript" page 2023-10-06 12:49:26 +03:00
Max Hilbrunner
97c0af67aa Merge pull request #8082 from bteixeira/patch-2 
Update gdscript_format_string.rst
 2023-10-06 01:44:51 +02:00
Danil Alexeev
6ad7f78001 GDScript: Update match patterns and literal docs 2023-10-05 19:18:05 +03:00
Max Hilbrunner
49ac573d24 Merge pull request #8094 from dalexeev/gds-add-match-pattern-guard-info 
GDScript: Document `match` pattern guards
 2023-10-04 18:57:54 +02:00
Yuri Sizov
ac728e8dd2 Update the state of C#/.NET support as of 4.2 2023-10-03 18:03:52 +02:00
Danil Alexeev
da3f1a1275 GDScript: Document match pattern guards 2023-09-29 14:28:44 +03:00
Bruno Teixeira
ebb36dc876 Update gdscript_format_string.rst 
Added missing documentation for `%v` string formatting for vectors.
 2023-09-28 15:11:37 +02:00
Elnar Dakeshov
4b6e15d3b3 Update style guide (#8038) 
Used get instead of set.
 2023-09-27 03:03:08 +02:00
Danil Alexeev
9aa85cee05 Update "GDScript documentation comments" page 2023-09-21 16:33:55 +03:00
Danil Alexeev
09d9d9a895 GDScript: Document raw string literals 2023-09-21 00:04:38 +03:00
Max Hilbrunner
64867d4341 Merge pull request #7812 from dalexeev/gds-mention-array-assign-method 
GDScript: Mention `Array.assign()` method in typed arrays documentation
 2023-09-10 20:12:38 +02:00
Hugo Locurcio
8e4f72f3f4 Mention typing of for loop variable in Static typing in GDScript 2023-08-21 19:44:52 +02:00
Danil Alexeev
34a620e2c2 GDScript: Mention Array.assign() method in typed arrays documentation 2023-08-16 11:30:39 +03:00
Danil Alexeev
60e3f14d98 Update "GDScript documentation comments" page 2023-08-01 11:52:42 +03:00
Aaron
81f1db2ca8 Fix the spelling and example list code. 2023-07-19 12:15:22 -04:00
Max Hilbrunner
df7068bf03 Merge pull request #7603 from dalexeev/gds-arrays 2023-07-18 17:06:50 +02:00
Max Hilbrunner
5dc2506ed8 Merge pull request #7591 from dalexeev/gds-warn-override-non-virtual 2023-07-18 13:41:05 +02:00
Ninni Pipping
1a1500cebe Fix outdated use of File in gdscript_basics 2023-07-17 16:22:30 +02:00
CactiChameleon9
cf5222b129 Fix mention of Godot3's or_lesser for export_range 2023-07-08 06:34:20 +01:00
Danil Alexeev
9fb9915ad9 GDScript: Document static variables 2023-07-03 14:58:23 +03:00
Danil Alexeev
1be213cbe8 GDScript: Update array documentation 
* Add info about typed arrays.
* Fix the error that packed arrays are passed by value.
 2023-07-03 14:40:09 +03:00
Danil Alexeev
055ec902ce GDScript: Add warning about overriding non-virtual native methods 2023-07-01 21:26:48 +03:00
Danil Alexeev
98f5970a6f GDScript: Clarify setter/getter documentation 2023-06-30 21:28:02 +03:00
Hannes
085d4035a3 Changed a code example that didn't follow the style guide 2023-06-26 11:42:11 +02:00
Danil Alexeev
d8e71f7453 Update info about BBCode in doc comments and Class Reference 2023-05-29 21:43:10 +03:00