Salome HOME
Ameliorate help pages
[modules/shaper.git] / src / SketchPlugin / doc / lineFeature.rst
index a832a7e132beda8ae179f7a4f95c5179aec571e0..a45094e7669cc4e34967b4334e16d0a26a381fd0 100644 (file)
@@ -1,21 +1,17 @@
+.. _sketchLine:
+.. |line.icon|    image:: images/line.png
 
 Line
 ====
 
-The feature Line creates a line segment by two points in the current Sketch.
+Line feature creates a line segment by two points in the current Sketch.
 
-To add new Line to the Sketch:
+To add new Line to the Sketch:
 
 #. select in the Main Menu *Sketch - > Line* item  or
-#. click **Line** button in Sketch toolbar:
+#. click |line.icon| **Line** button in Sketch toolbar:
 
-.. image:: images/line.png
-   :align: center
-
-.. centered::
-   **Line**  button
-
-The following property panel appears.
+The following property panel appears:
 
 .. image:: images/Line_panel.png
   :align: center
@@ -23,14 +19,19 @@ The following property panel appears.
 .. centered::
    Line
 
-Pick 2 points (start and end) in the view to create a Line. In the case of click on an existing object constraint for
-the point will be created automatically.
+Pick 2 points (start and end) in the view to create a Line. If an existing object is clicked, a constraint for the point will be created automatically.
 
 Start and end points coordinates are displayed in the property panel.
 
-**TUI Command**:  *Sketch_1.addLine(X1, Y1, X2, Y2)*
+**TUI Command**:
+
+.. py:function:: Sketch_1.addLine(X1, Y1, X2, Y2)*
 
-**Arguments**:    4 values (coordinates of the start and end points).
+    :param real: X1 value.
+    :param real: Y1 value.
+    :param real: X2 value.
+    :param real: Y2 value.
+    :return: Result object.
 
 Result
 """"""
@@ -43,4 +44,4 @@ Created line appears in the view.
 .. centered::
    Line created
 
-**See Also** a sample TUI Script of :ref:`tui_create_line` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_line` operation.