Salome HOME
Revert "bos#35152 [EDF] (2023-T1) Sketch Circle should allow user to position constru...
[modules/shaper.git] / src / SketchPlugin / doc / collinearFeature.rst
index f8346dd26c03a42b6ed1935a000a5a88cd9625dd..ffa767acd860438f3642cf63b4efa2dc13bfb9c7 100644 (file)
@@ -1,23 +1,18 @@
+.. |collinear.icon|    image:: images/collinear.png
 
 Collinear constraint
 ====================
 
-Collinear constraint makes to lines collinear.
+Collinear constraint forces lines to be collinear.
 
-To create Collinear in the active Sketch:
+To create a Collinear constraint in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Collinear* item  or
-#. click **Collinear** button in Sketch toolbar:
-
-.. image:: images/collinear.png
-   :align: center
-
-.. centered::
-   **Collinear**  button
+#. click |collinear.icon| **Collinear** button in Sketch toolbar:
 
 Property panel:
 
-.. image:: images/Collinear_panel.png
+.. figure:: images/Collinear_panel.png
    :align: center
 
 Input fields:
@@ -25,22 +20,25 @@ Input fields:
 - **First line** is the first line selected in the view.
 - **Second line** is the second line selected in the view.
 
-| After the lines are selected they becomes translated as to be collinear.
-| The lines are marked with the special sign.
+| After the lines are selected, they are translated to become collinear.
+| The lines are marked with a special sign.
 
-**TUI Command**: *Sketch_1.setCollinear(Line1, Line2)*
+**TUI Command**:
 
-**Arguments**:  2 line objects
+.. py:function:: Sketch_1.setCollinear(Line1, Line2)
+
+    :param object: First object.
+    :param object: Second object.
+    :return: Result object.
 
 Result
 """"""
 
 Created Collinear constraint appears in the view.
 
-.. image:: images/Collinear_res.png
-          :align: center
+.. figure:: images/Collinear_res.png
+   :align: center
 
-.. centered::
-   Collinear constraint created
+   Created collinear constraint
 
-**See Also** a sample TUI Script of :ref:`tui_create_collinear` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_collinear` operation.