Ameliorate help pages

[modules/shaper.git] / src / FeaturesPlugin / doc / transformationFeature.rst

diff --git a/src/FeaturesPlugin/doc/transformationFeature.rst b/src/FeaturesPlugin/doc/transformationFeature.rst
index 91629ac5cdca38cdb7e917bf5532d5ce2c864164..6e859459258c6a9456f72157b1ab7157a6b6be27 100644 (file)
--- a/src/FeaturesPlugin/doc/transformationFeature.rst
+++ b/src/FeaturesPlugin/doc/transformationFeature.rst
@@ -1,19 +1,14 @@
+.. |scale.icon|    image:: images/scale.png
 
 Scale
 =====
 
-The feature **Scale** makes a scaled shape basing on the initial shape.
+**Scale** feature makes a scaled shape basing on the initial shape.
 
-To create Scale in the active part:
+To create a Scale in the active part:
 
 #. select in the Main Menu *Features - > Scale* item  or
-#. click **Scale** button in the toolbar
-
-.. image:: images/scale.png      
-   :align: center
-
-.. centered::
-   **Scale** button 
+#. click |scale.icon| **Scale** button in the toolbar
 
 Two Scale algorithms are:
 
@@ -42,9 +37,15 @@ Input fields:
 - **Center point** defines the point relatively to which the object is scaled. Point is selected in 3D OCC viewer or object browser;
 - **Scale factor** defines the multiplier of axial dimensions. If Scale Factor is negative, the object is mirrored through the Central Point. 
 
-**TUI Command**:  *model.addScale(Part_doc, [shape], center, factor)*
+**TUI Command**:
+
+.. py:function:: model.addScale(Part_doc, [shape], center, factor)
  
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + center point in format *model.selection(TYPE, shape)*+ real (scale factor value).
+    :param part: The current part object.
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+    :param object: A center point in format *model.selection(TYPE, shape)*.
+    :param real: Scale factor.
+    :return: Result object.
 
 Result
 """"""
@@ -57,7 +58,7 @@ Result of operation is transformed initial shape shown in wireframe mode togethe
 .. centered::
    Scale by one common factor
 
-**See Also** a sample TUI Script of a :ref:`tui_Scale_common_factor` operation.  
+**See Also** a sample TUI Script of :ref:`tui_Scale_common_factor` operation.  
 
 Scale by different factors along axes
 -------------------------------------
@@ -76,9 +77,15 @@ Input fields:
 - **Center point** defines the point relatively to which the object is scaled. Point is selected in 3D OCC viewer or object browser;
 - **Scale factor in X**, **Scale factor in Y**, **Scale factor in Z** define the the multipliers of axial dimensions.  If Scale Factor is negative, the object is mirrored through the Central Point. 
 
-**TUI Command**:  *model.addScale(Part_doc, [shape], center, factors)*
+**TUI Command**:
+
+.. py:function:: model.addScale(Part_doc, [shape], center, factors)
  
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + center point in format *model.selection(TYPE, shape)*+ 3 reals (scale factor values along X. Y, Z axes).
+    :param part: The current part object.
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+    :param object: A center point in format *model.selection(TYPE, shape)*.
+    :param list: A list of three scale factor values along X. Y, Z axes.
+    :return: Result object.
 
 Result
 """"""
@@ -91,4 +98,4 @@ Result of operation is transformed initial shape.
 .. centered::
    Scale by different factors
 
-**See Also** a sample TUI Script of a :ref:`tui_Scale_XYZ` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_Scale_XYZ` operation.
\ No newline at end of file