Ameliorate help pages

[modules/shaper.git] / src / SketchPlugin / doc / rotationFeature.rst

diff --git a/src/SketchPlugin/doc/rotationFeature.rst b/src/SketchPlugin/doc/rotationFeature.rst
index fb5324a6c17338f70c20b35874654743c6184d31..14f59eaeabab1f9ed71f6d6a2e93309ab60dca55 100644 (file)
--- a/src/SketchPlugin/doc/rotationFeature.rst
+++ b/src/SketchPlugin/doc/rotationFeature.rst
@@ -1,20 +1,15 @@
 .. _sketchAngularCopy:
+.. |rotate.icon|    image:: images/rotate.png
 
 Angular copy
 ============
 
-Angular copy operation creates one or multiple copies of the skecth entities by rotation relative to a specified center point.
+Angular copy operation creates one or multiple copies of the sketch entities by rotation relative to a specified center point.
 
-To create Angular copy in the active Sketch:
+To create an Angular copy in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Angular copy* item  or
-#. click **Angular copy** button in Sketch toolbar:
-
-.. image:: images/rotate.png
-   :align: center
-
-.. centered::
-   **Angular copy**  button
+#. click |rotate.icon| **Angular copy** button in Sketch toolbar:
 
 Property panel:
 
@@ -26,8 +21,8 @@ Property panel:
 
 Input fields:
 
-- **Segments** is the list of segments (lines, circles, arcs) selected in the view.
-- **Center of rotation** is the center point selected in the view.
+- **Segments** is the list of segments (lines, circles, arcs) selected in the view;
+- **Center of rotation** is the center point selected in the view;
 - **Full angle/Single angle** option:
 
   .. image:: images/angle_up_full_32x32.png
@@ -39,26 +34,34 @@ Input fields:
   **Single angle**: angle step of rotation is equal to the defined angle.
 
 - **Angle** is the angle of rotation.
-- **Reversed** defines rotation direction. If checked - in clockwise direction, otherwise - in a counterclockwise direction.
+- **Reversed** defines rotation direction. If checked - in a clockwise direction, otherwise - in a counterclockwise direction.
 - **Total number of objects** is the total number of objects including the original one.
 
 
-**TUI Command**: *Sketch_1.addRotation(Objects, CenterPoint, Angle, NumberOfObjects, FullValue, Reversed)*
+**TUI Command**:
+
+.. py:function:: Sketch_1.addRotation(Objects, CenterPoint, Angle, NumberOfObjects, FullValue, Reversed)
 
-**Arguments**:   list of objects + center point + angle + number of objects + full value flag + reversed flag
+    :param list: A list of objects.
+    :param object: Center point.
+    :param real: Angle.
+    :param integer: Number of objects.
+    :param boolean: Full value flag.
+    :param boolean: Reversed flag.
+    :return: Result object.
 
 Result
 """"""
 
 Created Angular copy appears in the view.
 
-| The original and an angular copy objects are marked with the special sign.
+| The original and an angular copy objects are marked with a special sign.
 | Copy objects are drawn with a thinner line.
 
 .. image:: images/Rotation_res.png
           :align: center
 
 .. centered::
-   Angular copy created
+   Created angular copy
 
-**See Also** a sample TUI Script of a :ref:`tui_create_rotation` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_rotation` operation.