Just a few edits fixing Sphinx syntax errors.

KSP-KOS · Jan 28, 2019 · ca3a6d1 · ca3a6d1
1 parent 017391a
commit ca3a6d1
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 36 deletions.
diff --git a/doc/source/structures/misc/vecdraw.rst b/doc/source/structures/misc/vecdraw.rst
@@ -38,10 +38,11 @@ Drawing Vectors on the Screen
 
     Vector arrows can also be created with dynamic positioning and color.  To do
     this, instead of passing static values for the first three arguments of
-    ``VECDRAW()`` or ``VECDRAWARGS()``, you can pass a :ref:`Delegate` for
-    any of them, which returns a value of the correct type.  Here's an example
-    where the Start, Vec, and Color are all dynamically adjusted by anonymous
-    delegates that kOS will frequently call for you as it draws the arrow::
+    ``VECDRAW()`` or ``VECDRAWARGS()``, you can pass a
+    :ref:`Delegate <delegates>` for any of them, which returns a value of the
+    correct type.  Here's an example where the Start, Vec, and Color are all
+    dynamically adjusted by anonymous delegates that kOS will frequently call
+    for you as it draws the arrow::
 
         // Small dynamically moving vecdraw example:
         SET anArrow TO VECDRAW(

diff --git a/doc/source/structures/orbits/orbit.rst b/doc/source/structures/orbits/orbit.rst
@@ -345,7 +345,7 @@ Deprecated Suffix
 
  .. attribute:: Orbit:PATCHES
 
-     :type: :struct:`List` of :struct:`Orbit` Objects
+    :type: :struct:`List` of :struct:`Orbit` Objects
     :access: Get only
 
      .. note::

diff --git a/doc/source/structures/orbits/orbitable.rst b/doc/source/structures/orbits/orbitable.rst
@@ -16,36 +16,33 @@ All objects that can move in orbit around other objects share some similar struc
     **These terms are all read-only.**
 
     ======================= ==============
-     Suffix                  Type (units)
+    Suffix                  Type (units)
+    ======================= ==============
+    :attr:`NAME`            :struct:`String`
+    :attr:`BODY`            :struct:`Body`
+    :attr:`HASBODY`         :struct:`boolean`
+    :attr:`HASORBIT`        :struct:`boolean`
+    :attr:`HASOBT`          :struct:`boolean`
+    :attr:`OBT`             :struct:`Orbit`
+    :attr:`ORBIT`           :struct:`Orbit`
+    :attr:`UP`              :struct:`Direction`
+    :attr:`NORTH`           :struct:`Direction`
+    :attr:`PROGRADE`        :struct:`Direction`
+    :attr:`SRFPROGRADE`     :struct:`Direction`
+    :attr:`RETROGRADE`      :struct:`Direction`
+    :attr:`SRFRETROGRADE`   :struct:`Direction`
+    :attr:`POSITION`        :struct:`Vector`
+    :attr:`VELOCITY`        :struct:`OrbitableVelocity`
+    :attr:`DISTANCE`        :ref:`scalar <scalar>` (m)
+    :attr:`DIRECTION`       :struct:`Direction`
+    :attr:`LATITUDE`        :ref:`scalar <scalar>` (deg)
+    :attr:`LONGITUDE`       :ref:`scalar <scalar>` (deg)
+    :attr:`ALTITUDE`        :ref:`scalar <scalar>` (m)
+    :attr:`GEOPOSITION`     :struct:`GeoCoordinates`
+    :attr:`PATCHES`         :struct:`List` of :struct:`Orbits <Orbit>`
+    :attr:`APOAPSIS`        :ref:`scalar <scalar>` (m) (Deprecated, use :OBT:APOAPSIS instead.)
+    :attr:`PERIAPSIS`       :ref:`scalar <scalar>` (m) (Deprecated, use :OBT:PERIAPSIS instead.)
     ======================= ==============
-     :attr:`NAME`            :struct:`String`
-     :attr:`BODY`            :struct:`Body`
-     :attr:`HASBODY`         :struct:`boolean`
-     :attr:`HASORBIT`        :struct:`boolean`
-     :attr:`HASOBT`          :struct:`boolean`
-     :attr:`OBT`             :struct:`Orbit`
-     :attr:`ORBIT`           :struct:`Orbit`
-     :attr:`UP`              :struct:`Direction`
-     :attr:`NORTH`           :struct:`Direction`
-     :attr:`PROGRADE`        :struct:`Direction`
-     :attr:`SRFPROGRADE`     :struct:`Direction`
-     :attr:`RETROGRADE`      :struct:`Direction`
-     :attr:`SRFRETROGRADE`   :struct:`Direction`
-     :attr:`POSITION`        :struct:`Vector`
-     :attr:`VELOCITY`        :struct:`OrbitableVelocity`
-     :attr:`DISTANCE`        :ref:`scalar <scalar>` (m)
-     :attr:`DIRECTION`       :struct:`Direction`
-     :attr:`LATITUDE`        :ref:`scalar <scalar>` (deg)
-     :attr:`LONGITUDE`       :ref:`scalar <scalar>` (deg)
-     :attr:`ALTITUDE`        :ref:`scalar <scalar>` (m)
-     :attr:`GEOPOSITION`     :struct:`GeoCoordinates`
-     :attr:`PATCHES`         :struct:`List` of :struct:`Orbits <Orbit>`
-    ----------------------- --------------
-    The Following are deprecated (use apoapsis and periapsis on :attr:`OBT`)
-    --------------------------------------
-     :attr:`APOAPSIS`        :ref:`scalar <scalar>` (m)
-     :attr:`PERIAPSIS`       :ref:`scalar <scalar>` (m)
-     ======================= ==============
 
 
 .. attribute:: Orbitable:NAME
@@ -209,7 +206,10 @@ All objects that can move in orbit around other objects share some similar struc
 
     .. deprecated:: 0.15
 
-       Use :attr:`OBT:APOAPSIS <Orbit:APOAPSIS>` instead.
+       This is only kept here for backward compatibility.
+       in new scripts you write, use :attr:`OBT:APOAPSIS <Orbit:APOAPSIS>`.
+       (i.e. use ``SHIP:OBT:APOAPSIS`` instead of ``SHIP:APOAPSIS``,
+       or use ``MUN:OBT:APOAPSIS`` instead of ``MUN:APOAPSIS``, etc).
 
 .. attribute:: Orbitable:PERIAPSIS
 
@@ -218,4 +218,7 @@ All objects that can move in orbit around other objects share some similar struc
 
     .. deprecated:: 0.15
 
-       Use :attr:`OBT:PERIAPSIS <Orbit:PERIAPSIS>` instead.
+       This is only kept here for backward compatibility.
+       in new scripts you write, use :attr:`OBT:PERIAPSIS <Orbit:PERIAPSIS>`.
+       (i.e. use ``SHIP:OBT:PERIAPSIS`` instead of ``SHIP:PERIAPSIS``).
+       or use ``MUN:OBT:PERIAPSIS`` instead of ``MUN:PERIAPSIS``, etc).