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
806a4fccfd
Add a page on the Output bottom panel
2024-12-07 08:40:44 +01:00
Andrey Solomatin
832e85d38a
Made edits to match GDScript code order
...
Updated gdscript_documentation_comments.rst
2024-10-31 12:36:54 +03:00
Danil Alexeev
c89b0e6ab3
Update class reference and doc comment markup documentation
2024-05-02 13:14:02 +03:00
Danil Alexeev
200c91b679
GDScript: Update deprecated/experimental docs
2024-02-16 12:00:18 +03: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
Danil Alexeev
9aa85cee05
Update "GDScript documentation comments" page
2023-09-21 16:33:55 +03:00
Danil Alexeev
60e3f14d98
Update "GDScript documentation comments" page
2023-08-01 11:52:42 +03:00
Danil Alexeev
d8e71f7453
Update info about BBCode in doc comments and Class Reference
2023-05-29 21:43:10 +03:00
Danil Alexeev
15f32c5407
GDScript: Add mention that @onready @export doesn't work as expected
2023-05-27 15:25:50 +03:00
Cameron
da69035b1c
minor grammar and typo in gdscript_documentation_comments.rst
2023-04-30 10:47:39 -07:00
Max Hilbrunner
64a3b465c2
Update SFC to Godot Foundation, old URLs
2023-04-17 23:53:52 +02:00
iwVerve
7b4684b7a0
missing word typo on documentation comments page
2023-04-11 14:07:12 +02:00
GeroVeni
4d6964bc9e
Add enum examples to the documentation comments
2023-02-17 09:32:48 +00:00
Danil Alexeev
e161f86cf5
Update docs about doc comments (@desc: replaced with blank line) ( #5838 )
2022-05-26 19:40:34 +02:00
Rémi Verschelde
9a05eef561
4.0: Convert Sprite references to Sprite2D
...
Some screenshots will need to be updated so that the scene structures shown
in screenshot fit what the code blocks are referring to.
2021-10-06 14:29:55 +02:00
Aaron Franke
4060179184
Remove trailing space characters ( #5251 )
2021-09-13 14:52:39 +02:00
luzpaz
d9bc787dd9
Fix various typos ( #5215 )
...
Fix various typos
Found via `codespell -q 3 -S ./LICENSE.txt -L doubleclick,findn,lod,inout,nd,raison,te`
2021-09-02 17:02:23 +03:00
Thakee Nathees
6fac7f0d8d
documentation for the GDScript documentation comments
...
(thanks @baloonpopper and @Calinou for the nitpicks)
Co-ayuthored-by: balloonpopper<5151242+balloonpopper@users.noreply.github.com >
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro >
2020-12-25 11:34:15 +05:30
