Commit Graph

310 Commits

Author SHA1 Message Date
Yuri Sizov
075acc61b0 Replace Pool*Arrays with Packed*Arrays in tutorials and references 2020-03-17 11:15:34 +03:00
Yuri Sizov
37604be65f Improved keystroke formatting for shortcuts and key press menti… (#3257) 2020-03-09 23:50:53 +01:00
Michael Alexsander
95784cf94f General formating fixes for GDScript scripting pages (#3248) 2020-03-06 20:28:58 +01:00
Michael Alexsander
3f9c09fbf7 Small fixes for recent formating errors (#3247) 2020-03-06 13:51:11 +01:00
Jason Swearingen
5b9558f6ca Update docs regarding current Nuget workflow (#3038)
highlighting proper workflow as per my discovery here: https://github.com/godotengine/godot/issues/34803#issuecomment-570752688
2020-03-04 09:35:20 +01:00
Johannes Witt
1eab94c72d Added looped Coroutine Example to GDScript Basics (#2586) 2020-03-03 22:28:56 +01:00
Aaron Franke
3c99a213ae Document Godot preprocessor defines 2020-02-18 02:21:46 -05:00
Rémi Verschelde
e60bb57b4b Mono: Mention that log profiler is Unix-only for now
Cf. godotengine/godot#29005.
2020-02-17 14:45:33 +01:00
Michael Alexsander
91df8e4ed2 Apply minor fixups to the GDScript styleguide 2020-02-05 22:19:23 -03:00
Rémi Verschelde
1df5a0ae68 Merge pull request #3061 from asynts/asynts.syntax-highlighting-2
Incorrect syntax highlighting for languages other than GDScript.
2020-01-27 08:39:00 +01:00
Marincia Catalin
37670ff9e4 Replaced wrong semicolon by a colon ! 2020-01-23 23:31:35 +02:00
Michael Alexsander
ecc41a15f4 Fix trailing comma examples in style guide page 2020-01-23 16:00:31 -03:00
Feniks
98bcb8af4a Updated style guide to include enums and dir in exception to 2… (#3082)
It appears that general consensus across the docs is that 2 indents for continuous line rule does not apply to enums and dictionaries. This is not mentioned in docs which is confusing to anyone who doesn't know about unofficial exception. This commit makes it official
2020-01-22 15:15:14 +01:00
Michael Alexsander
866b0a8801 Fix formatting errors in VS2019 debugging section (#3095)
* Fix formatting errors in VS2019 debugging section

* Add explanatory notes, more style fixes

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-01-22 14:22:01 +01:00
Jason Swearingen
4a3472449f Add VS2019 Support for C# Debugging (c_sharp_basics.rst) (#3088)
* Update c_sharp_basics.rst

Add docs showing how VS2019 is supported.   re: https://github.com/godotengine/godot-proposals/issues/371

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-01-21 21:14:48 +01:00
Michael Alexsander
83511dc224 Fix nonexistent reference in the "GDScript style guide" page 2020-01-14 18:26:02 -03:00
Nathan Lovato
9a64d9a5c5 GDScript style guide: add suggested code order (#3022)
* GDScript style guide: add suggested code order

Following the discussion in #2997

* Update the code order example in the GDScript style guide
2020-01-14 18:23:24 +01:00
asynts
53f878bdaf Replace 'code' directives with 'code-block' directives.
The `code` directive highlights all sources as GDScript. Other languages are
highlighted incorrectly at the moment, even if `.. code:: [language]` is
specified.

It does, however, work with the `code-block` directive. The reason seems to be
that this directive is Sphinx specific.
2020-01-13 18:45:39 +01:00
asynts
3dede275f4 Use literal blocks for code samples with GDScript.
GDScript is already the default, it's redundant to specify it explicitly.
A [literal block][1] is already enough.

  [1]: https://www.sphinx-doc.org/en/1.8/usage/restructuredtext/basics.html#rst-literal-blocks
2020-01-13 18:45:39 +01:00
Igor
088279f8e2 Fix typo in Vector2 description 2020-01-13 09:34:48 +02:00
Nathan Lovato
dcb9cb43e8 Tweak GDScript and C# Style guides
Rename code structure -> formatting
Add a heading Encoding and special characters for the corresponding section
Add missing Indentation heading that was gone
2020-01-06 13:55:46 +01:00
Aaron Franke
766e4687e5 Add file formatting to GDScript style guide
Recommend LF, newline at end of file, UTF-8, no BOM, and tabs. The displayed size of tabs does not matter as it does not affect the saved files, so don't mention it. Also slightly change the C# style guide for consistency.
2020-01-04 16:59:52 -05:00
Hugo Locurcio
529004eec2 Merge pull request #3005 from van800/master
"Profiling your C# code" in c_sharp_basics.rst
2020-01-03 22:42:23 +01:00
Michael Alexsander
f7505fdf79 Add references for the built-in type pages in GDScript basics 2020-01-03 14:52:48 -03:00
Nathan Lovato
f56dee8d22 Change phrasing of the line length gdscript guideline. 2020-01-02 20:26:43 +01:00
Nathan Lovato
373f662571 Merge pull request #2994 from Calinou/add-gdscript-line-length-guideline
Add a line length guideline to the GDScript style guide
2020-01-02 20:08:58 +01:00
Nathan Lovato
60b8b5b11b Fix typo before comment 2020-01-02 09:48:10 +01:00
Nathan Lovato
176d4482be Edit gdscript_styleguide 2019-12-31 20:26:33 +01:00
Nathan Lovato
0321330075 Merge pull request #2995 from Calinou/add-gdscript-boolean-operators-guideline
Add a boolean operators guideline to the GDScript style guide
2019-12-31 19:46:45 +01:00
Nathan Lovato
c640a90329 Merge pull request #2996 from Calinou/add-gdscript-enums-guideline
Add an enum naming guideline to the GDScript style guide
2019-12-31 19:41:44 +01:00
Nathan Lovato
b19ead1230 Merge pull request #2967 from Scony/func-call-operator
function call operator added to operator table
2019-12-31 12:49:55 +01:00
Michael Alexsander
19417063c8 Very small styling fixups to the GDScript export page 2019-12-27 15:00:11 -03:00
Ivan.Shakhov
3e7de6e92b "Profiling your C# code" in c_sharp_basics.rst 2019-12-25 00:19:28 +01:00
Ryan Roden-Corrent
584ff890d4 Add link to tool docs in gdscript docs.
The gdscript_basics docs give a pretty sparse description of the tool
keyword. I ended up figuring out a lot of it on my own before I finally
realized there was a more detailed page hidden elsewhere in the docs.
2019-12-24 08:09:47 -05:00
theowiik
640816652d Add clarification on how to connect C# signals in the editor (#2963)
* add clarification on how to see c# signals in the editor

* reference the top right build button instead of the mono tab
2019-12-22 20:28:56 +01:00
Matthew
994bb2530a Add a list of supported external editors and update C# version info (#2991) 2019-12-21 12:11:46 +01:00
Paul Joannon
fae465f34f Documentation page about C#/GDScript interactions (#2826) 2019-12-21 11:52:32 +01:00
Hugo Locurcio
f3aaa480e2 Add an enum naming guideline to the GDScript style guide
This partially addresses #1736.
2019-12-20 19:31:16 +01:00
Hugo Locurcio
c6fa2483f8 Add a boolean operators guideline to the GDScript style guide 2019-12-20 19:17:11 +01:00
Hugo Locurcio
bc47ace471 Add a line length guideline to the GDScript style guide
This closes #2567.
2019-12-20 19:06:56 +01:00
Pawel Lampe
fa5a7c2761 function call operator added to operator table 2019-12-05 19:28:38 +01:00
Lamonte
45fcc02431 Added new gotcha regarding snake_case for certain api methods (#2955)
Cleaned up wording to be cleaner
2019-12-03 08:40:16 +01:00
Nathan Lovato
82dd565936 Change less -> fewer 2019-11-25 11:04:02 +01:00
Hugo Locurcio
193b866848 Add quote style recommendation to the GDScript style guide
This closes #2869.
2019-11-14 15:00:28 +01:00
PouleyKetchoupp
854185495c Fixed code tags for true/false/null and a few property references 2019-11-02 13:09:14 +01:00
Rémi Verschelde
219b3f91f4 Merge pull request #2766 from Kaligule/patch-3
Document all comments that disable warnings
2019-10-29 12:06:05 +01:00
Rémi Verschelde
aa646a74f3 Merge pull request #2849 from KellyThomas/csharp-export-docs
Document using PropertyHint with [Export]
2019-10-29 10:01:18 +01:00
Rémi Verschelde
7287412268 Merge pull request #2844 from Calinou/clarify-gdscript-export-step
Clarify how the "step" value behaves in GDScript exports
2019-10-29 09:14:24 +01:00
Aaron Franke
1dfb69578c GDScript style guide: Add comments section, and change quotes (#2868)
* Add section about spacing comments

* Replace single quotes with double quotes
2019-10-23 13:32:24 +02:00
Johan Thelin
90c8056e8c Change example signal name to animation_finished
The AnimationPlayer signal used to demonstrate the yield function is called "animation_finished".
2019-10-19 15:36:50 +02:00