Merge branch 'csgroup_IS2'

[modules/shaper.git] / src / BuildPlugin / doc / edgeFeature.rst

diff --git a/src/BuildPlugin/doc/edgeFeature.rst b/src/BuildPlugin/doc/edgeFeature.rst
index a94a22020fe68a429c1a2f4df03ca590e0abd896..e94acf0bc18ecc213b08af27d303a5fe658d517d 100644 (file)
--- a/src/BuildPlugin/doc/edgeFeature.rst
+++ b/src/BuildPlugin/doc/edgeFeature.rst
@@ -12,25 +12,30 @@ To create edges in the active part:
 
 The options to create edges:
 
-.. image:: images/edge_by_segments_32x32.png
+.. figure:: images/edge_by_segments_32x32.png
    :align: left
-**By edges** creates edges using already existing edges in other shapes.
+   :height: 24px
 
-.. image:: images/edge_by_points_32x32.png
+**By edges** creates edges using already existing edges in other shapes or full sketches.
+
+.. figure:: images/edge_by_points_32x32.png
    :align: left
+   :height: 24px
+
 **By points** creates segment between two points.
 
+--------------------------------------------------------------------------------
 
 By edges
 --------
 
-.. image:: images/Edge.png
+.. figure:: images/Edge.png
   :align: center
 
-.. centered::
   Create by edges
 
-Select one or several edges in the viewer.
+Select one or several edges in the viewer. Also, the full sketch can be selected. In this case, all edges of the sketch will be processed.
+Checkbox **Compute intersections** forces to split sketch edges in the points of intersection.
 
 **Apply** button creates edges.
 
@@ -38,10 +43,11 @@ Select one or several edges in the viewer.
 
 **TUI Command**:
 
-.. py:function:: model.addEdge(Part_doc, Shapes)
+.. py:function:: model.addEdge(Part_doc, Shapes, Intersect)
 
     :param part: The current part object.
     :param list: A list of shapes.
+    :param bool: Split edges by intersection points. False by default.
     :return: Result object.
 
 Result
@@ -49,10 +55,9 @@ Result
 
 The result of the operation will be a set of edges created from the selected shapes:
 
-.. image:: images/CreateEdge.png
+.. figure:: images/CreateEdge.png
   :align: center
 
-.. centered::
   Result of the operation.
 
 **See Also** a sample TUI Script of :ref:`tui_create_edge` operation.
@@ -61,10 +66,9 @@ The result of the operation will be a set of edges created from the selected sha
 By two points
 -------------
 
-.. image:: images/EdgeByTwoPoints.png
+.. figure:: images/EdgeByTwoPoints.png
   :align: center
 
-.. centered::
   Create by points
 
 Select two points in the viewer.
@@ -87,10 +91,9 @@ Result
 
 The result of the operation will be a segment bounded by selected points:
 
-.. image:: images/CreateEdgeByPoints.png
+.. figure:: images/CreateEdgeByPoints.png
   :align: center
 
-.. centered::
   Result of the operation.
 
 **See Also** a sample TUI Script of :ref:`tui_create_segment` operation.