Skip to content

Commit

Permalink
minor documentation fix
Browse files Browse the repository at this point in the history
  • Loading branch information
maxcapodi78 authored and maxcapodi78 committed Apr 18, 2024
1 parent 2aeb68b commit d1cd5b6
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion doc/source/API/Primitives2D.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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")
...
4 changes: 2 additions & 2 deletions doc/source/API/Primitives3D.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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")
...
2 changes: 1 addition & 1 deletion doc/source/Getting_started/Contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 4 additions & 2 deletions doc/source/User_guide/modeler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit d1cd5b6

Please sign in to comment.