Ameliorate help pages

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

diff --git a/src/FeaturesPlugin/doc/extrusionCutFeature.rst b/src/FeaturesPlugin/doc/extrusionCutFeature.rst
index 344e0a0d98a3ac1c1c077bcecbecdb6db9dde146..ca3499c2cbb63382f402fb81c647fbd5f0b45817 100644 (file)
--- a/src/FeaturesPlugin/doc/extrusionCutFeature.rst
+++ b/src/FeaturesPlugin/doc/extrusionCutFeature.rst
@@ -1,3 +1,4 @@
+.. |extrusion_cut_btn.icon|    image:: images/extrusion_cut_btn.png
 
 Extrusion Cut
 =============
@@ -7,13 +8,7 @@ Extrusion Cut feature extrudes selected objects along their normals or selected
 To perform Extrusion Cut in the active part:
 
 #. select in the Main Menu *Features - > Extrusion Cut* item  or
-#. click **Extrusion Cut** button in the toolbar
-
-.. image:: images/extrusion_cut_btn.png
-   :align: center
-
-.. centered::
-   **Extrusion Cut** button
+#. click |extrusion_cut_btn.icon| **Extrusion Cut** button in the toolbar
 
 The following property panel will be opened:
 
@@ -49,21 +44,43 @@ By sizes
 - **From size** - size for extrusion in the opposite direction.
 - **Cut from** - contains a list of objects which will be cut from the result of extrusion.
 
-**TUI Command**:  *model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut);*
+**TUI Commands**:  
+
+.. py:function:: model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut)
 
-**Arguments**:   Part + list of objects for extrusion + size + list of objects to cut from.
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param number: Size of extrucion.
+    :param list: A list of objects to cut from.
+    :return: Created object.
 
-**TUI Command**:  *model.addExtrusionCut(part, objects, direction, size, objectsToCut);*
+.. py:function:: model.addExtrusionCut(part, objects, direction, size, objectsToCut)
 
-**Arguments**:   Part + list of objects for extrusion + direction + size + list of objects to cut from.
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: A direction of extrusion
+    :param number: Size of extrucion.
+    :param list: A list of objects to cut from.
+    :return: Created object.
 
-**TUI Command**:  *model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut);*
+.. py:function:: model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut)
 
-**Arguments**:   Part + list of objects for extrusion + to size + from size + list of objects to cut from.
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param number: "Size to" value.
+    :param number: "Size from" value.
+    :param list: A list of objects to cut from.
+    :return: Created object.
 
-**TUI Command**:  *model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut);*
+.. py:function:: model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut)
 
-**Arguments**:   Part + list of objects for extrusion + direction + to size + from size + list of objects to cut from.
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: A direction of extrusion
+    :param number: "Size to" value.
+    :param number: "Size from" value.
+    :param list: A list of objects to cut from.
+    :return: Created object.
 
 Result
 """"""
@@ -95,13 +112,30 @@ By bounding planes
 - **From offset** - offset for extrusion or for a bounding plane, if selected.
 - **Cut from** - contains a list of objects which will be cut from the result of extrusion.
 
-**TUI Command**:  *model.addExtrusionCut(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToCut);*
-
-**Arguments**:   Part + list of objects for extrusion + to object + to offset + from object + from offset + list of objects to cut from.
-
-**TUI Command**:  *model.addExtrusionCut(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToCut);*
-
-**Arguments**:   Part + list of objects for extrusion + direction + to object + to offset + from object + from offset + list of objects to cut from.
+**TUI Commands**:
+
+.. py:function:: model.addExtrusionCut(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToCut)
+
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: "To object".
+    :param number: "Offset to" value.
+    :param object: "From object".
+    :param number: "Offset from" value.
+    :param list: A list of objects to cut from.
+    :return: Created object.
+
+.. py:function:: model.addExtrusionCut(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToCut)
+
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: A direction of extrusion
+    :param object: "To object".
+    :param number: "Offset to" value.
+    :param object: "From object".
+    :param number: "Offset from" value.
+    :param list: A list of objects to cut from.
+    :return: Created object.
 
 Result
 """"""