diff --git a/contributing/doc_and_l10n_guidelines.rst b/contributing/doc_and_l10n_guidelines.rst index 4b1d4c139..bfff9bfc1 100644 --- a/contributing/doc_and_l10n_guidelines.rst +++ b/contributing/doc_and_l10n_guidelines.rst @@ -54,6 +54,7 @@ Please always begin pages with their title and a reference based on the file name (which should ideally be the same as the page title): :: + .. _insert_your_title_here: Insert your title here diff --git a/contributing/list_of_classes_and_documenters.rst b/contributing/list_of_classes_and_documenters.rst index 377b4ac62..00e90b143 100644 --- a/contributing/list_of_classes_and_documenters.rst +++ b/contributing/list_of_classes_and_documenters.rst @@ -5,7 +5,7 @@ List of classes and documenters **TODO: Move out of the Sphinx doc, a pad would be better** -Status list : Not started, Started, Finished, Removed +Status list: Not started, Started, Finished, Removed Class name - Assigned to - Status - Start date - Notes - @GDScript @@ -102,10 +102,8 @@ Class name - Assigned to - Status - Start date - Notes - Geometry - GeometryInstance - Globals -- GraphEdit - StraToN - Finished may need a tutorial. I'll - think about it. - -- GraphNode - StraToN - Finished  may need a tutorial. I'll - think about it. - +- GraphEdit - StraToN - Finished may need a tutorial. I'll think about it. - +- GraphNode - StraToN - Finished  may need a tutorial. I'll think about it. - - GridContainer - GridMap - GrooveJoint2D diff --git a/contributing/updating_the_class_reference.rst b/contributing/updating_the_class_reference.rst index 8b13592d6..8c4ecd9bf 100644 --- a/contributing/updating_the_class_reference.rst +++ b/contributing/updating_the_class_reference.rst @@ -8,7 +8,7 @@ use of to create your games. However, the :ref:`toc-class-ref` that lists all these classes with their methods is quite incomplete. We need your kind help to fill this reference. This page will explain you how. -> Please note: we aim at filling completely this reference in English +Please note: we aim at filling completely this reference in English first. Please do not start translating it for the moment. :ref:`doc_list_of_classes_and_documenters` @@ -95,113 +95,114 @@ You can edit this file using your favourite text editor. Here is an example with the Node2D class: .. code:: xml + - - Base node for 2D system. - - - Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierachies for animation and positioning. - - - - - - - Set the position of the 2d node. - - - - - - - Set the rotation of the 2d node. - - - - - - - Set the scale of the 2d node. - - - - - - - Return the position of the 2D node. - - - - - - - Return the rotation of the 2D node. - - - - - - - Return the scale of the 2D node. - - - - - - + + Base node for 2D system. + + + Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierachies for animation and positioning. - - - - - - - + + + + + + Set the position of the 2d node. + + + + + + + Set the rotation of the 2d node. + + + + + + + Set the scale of the 2d node. + + + + + + + Return the position of the 2D node. + + + + + + + Return the rotation of the 2D node. + + + + + + + Return the scale of the 2D node. + + + + + + - - - - - - - - - - - - - - Return the global position of the 2D node. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + Return the global position of the 2D node. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + As you can see, some methods in this class have no description (i.e. there is no text between their marks). This can also happen for the @@ -210,6 +211,7 @@ they are already filled. Let's edit the description of the rotate() method: .. code:: xml + diff --git a/reference/compiling_for_osx.rst b/reference/compiling_for_osx.rst index df2b533d9..416f4091f 100644 --- a/reference/compiling_for_osx.rst +++ b/reference/compiling_for_osx.rst @@ -35,7 +35,7 @@ Cross-compiling It is possible to compile for OSX in a Linux environment (and maybe also in Windows with Cygwin). For that you will need -`OSXCross `__to be able +`OSXCross `__ to be able to use OSX as target. First, follow the instructions to install it: Clone the `OSXCross repository ` diff --git a/reference/compiling_for_windows.rst b/reference/compiling_for_windows.rst index 0fd4cedea..c69f5c369 100644 --- a/reference/compiling_for_windows.rst +++ b/reference/compiling_for_windows.rst @@ -139,7 +139,7 @@ Windows export templates are created by compiling Godot as release, with the following flags: - (for 32 bits, using Mingw32 command prompt or Visual Studio command -prompt) + prompt) :: diff --git a/tutorials/vector_math.rst b/tutorials/vector_math.rst index 2053093cd..af70c1a64 100644 --- a/tutorials/vector_math.rst +++ b/tutorials/vector_math.rst @@ -89,7 +89,7 @@ trigonometry already, prepare to embrace vectors! In any case, obtaining an angle from a vector is easy and can be accomplished with trig... er, what was that? I mean, the -:ref:`atan2() class_@GDScript_atan2` function. +:ref:`atan2() ` function. Vectors in Godot ~~~~~~~~~~~~~~~~