From d1cd5b6564aa2a7060b664de2b329c0d88be505e Mon Sep 17 00:00:00 2001 From: maxcapodi78 Date: Thu, 18 Apr 2024 15:42:16 +0200 Subject: [PATCH] minor documentation fix --- doc/source/API/Primitives2D.rst | 2 +- doc/source/API/Primitives3D.rst | 4 ++-- doc/source/Getting_started/Contributing.rst | 2 +- doc/source/User_guide/modeler.rst | 6 ++++-- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/source/API/Primitives2D.rst b/doc/source/API/Primitives2D.rst index c41e3c5d1d0..da74f78de7f 100644 --- a/doc/source/API/Primitives2D.rst +++ b/doc/source/API/Primitives2D.rst @@ -46,6 +46,6 @@ modeler, including all primitives methods and properties: origin = [0,0,0] dimensions = [10,5,20] #Material and name are not mandatory fields - box_object = app.modeler.primivites.create_rectangle([15, 20, 0], [5, 5], matname="aluminum") + box_object = app.modeler.primivites.create_rectangle([15, 20, 0], [5, 5], material="aluminum") ... diff --git a/doc/source/API/Primitives3D.rst b/doc/source/API/Primitives3D.rst index 186fe639076..bfc61dd13c3 100644 --- a/doc/source/API/Primitives3D.rst +++ b/doc/source/API/Primitives3D.rst @@ -67,8 +67,8 @@ modeler, including all primitives methods and properties for HFSS, Maxwell 3D, Q # This call returns the NexximComponents class origin = [0,0,0] - dimensions = [10,5,20] + sizes = [10,5,20] #Material and name are not mandatory fields - box_object = app.modeler.primivites.create_box(origin, dimensions, name="mybox", matname="copper") + box_object = app.modeler.primivites.create_box(origin, sizes, name="mybox", material="copper") ... diff --git a/doc/source/Getting_started/Contributing.rst b/doc/source/Getting_started/Contributing.rst index c6a307fa7ce..c7392e86e40 100644 --- a/doc/source/Getting_started/Contributing.rst +++ b/doc/source/Getting_started/Contributing.rst @@ -127,7 +127,7 @@ Here is an example of an error: position = [0, 0, 0] dimensions_list = [0, 10, 10] name = None - matname = None + material = None ---------------------------------------------------------------------------------- (-2147352567, 'Exception occurred.', (0, None, None, None, 0, -2147024381), None) diff --git a/doc/source/User_guide/modeler.rst b/doc/source/User_guide/modeler.rst index 5a2ca96e538..e6d58daee23 100644 --- a/doc/source/User_guide/modeler.rst +++ b/doc/source/User_guide/modeler.rst @@ -9,8 +9,10 @@ The following code creates a box and changes the color to red: from pyaedt.hfss import Hfss hfss = Hfss() - box = hfss.modeler.create_box([0, 0, 0], [10, "dim", 10], - "mybox", "aluminum") + box = hfss.modeler.create_box(origin=[0, 0, 0], + sizes=[10, "dim", 10], + name="mybox", + material="aluminum") print(box.faces) box.color = "Red"