13 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
tetrapod00
c4d3aa134a Standardize RST header syntax 2024-12-29 13:44:09 -08:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Max Hilbrunner
80a92f4071 Merge pull request #6626 from RedMser/patch-3 2023-05-06 15:00:09 +02:00
Yuri Sizov
978a13bb0a Mark potentially outdated pages with a WIP warning 2023-02-26 14:21:15 +01:00
RedMser
9952aeec0b Document binary variant decoding/encoding helper 2023-01-17 18:57:18 +01:00
Max Hilbrunner
198393eec7 More Godot 4 rename fixes (#6315)
* Spatial -> 3D, Transform, Quaternion

* File -> FileAccess

* Camera -> Camera3D

* Update references to MeshInstance and MultiMeshInstance

* ImmediateGeometry -> ImmediateMesh, misc renames
2022-10-15 20:54:47 +02:00
Aaron Franke
4060179184 Remove trailing space characters (#5251) 2021-09-13 14:52:39 +02:00
Max Hilbrunner
33867029bb Merge pull request #4976 from levilindsey/master
Update the binary serialization API doc to accurately describe how Ob…
2021-08-10 12:22:35 +02:00
Marcin Sędłak-Jakubowski
bd19917ea0 Draft: Remove "simple", "simply", "easy", and "just" from the docs (#4496)
* Various style edits

* Edit out "simple" when possible

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Clay John <claynjohn@gmail.com>
2021-07-11 14:38:53 +02:00
Levi Lindsey
6050ba3bdc Update the binary serialization API doc to accurately describe how Objects are encoded. 2021-06-16 09:35:52 -07:00
Simone Gianni
3f60675227 Specify when integers and floats are 32 and when 64 bits (#4893)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-05-05 18:47:10 +02:00
Nathan Lovato
d29793759e Move binary_serialization_api to io/ 2020-10-08 14:14:44 -06:00