Improved documentation

[maxcapodi78]

No description provided.

[ansys-reviewer-bot]

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

[codecov]

Codecov Report

Merging #3716 (3978d22) into main (5e770b5) will increase coverage by 0.02%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3716      +/-   ##
==========================================
+ Coverage   81.01%   81.03%   +0.02%     
==========================================
  Files         179      179              
  Lines       61729    61850     +121     
==========================================
+ Hits        50007    50118     +111     
- Misses      11722    11732      +10     

[PipKat]

Suggested change

	The main parameters are position that provides the origin of the
	box and dimensions_list that provide the box sizes.
	The main parameters are ``position``, which provides the origin of the
	box, and ``dimensions_list``, which provide the box sizes.

Should "main" be "required" instead? Is the intent to indicate which parameters are required versus optional? I've not seen any other library do this type of parameter breakdown in their examples. Is it based on user feedback? Usually, the names of the parameters are clear enough--and aren't descriptions of all these parameters easily found in the "Parameters" section of the method? Also, if all methods apply to all 3D applications, perhaps this statement and the listing of these 3D apps can appear only once, as a note for the class maybe? I've edited the content for the other "Examples" sections, but I think you consider these points. And, if you decide to do this type of breakdown, I'd recommend using lists for the descriptions of the parameters, at least where there are several of them.

[PipKat]

Suggested change

	The following examples shows how to create a regular polyhedron in HFSS.
	The main parameters are cs_axis that provides the direction axis of the polyhedron,
	center_position that provides the center of the polyhedron, start_position of the polyhedron,
	height of the polyhedron and num_sides to determine the number of sides.
	The parameter matname is optional and allows to set the material name of the polyhedron.
	The parameter name is optional and allows to give a name to the polyhedron.
	This method applies to all 3D applications: HFSS, Q3D, Icepak, Maxwell 3D, Mechanical.
	This example shows how to create a regular polyhedron in HFSS.
	The main parameters are ``cs_axis``, `` center_position``, ``start_position``,
	``height``, and ``num_sides``. The ``cs_axis`` parameter provides the direction
	axis of the polyhedron. The ``center_position`` parameter provides the center
	of the polyhedron. The three other parameters provide the start position,
	height, and number of sides of the polyhedron.
	The optional parameter ``matname`` allows you to set the material name of
	the polyhedron. The optional parameter ``name`` allows you to assign a name
	to the polyhedron.
	This method applies to all 3D applications: HFSS, Q3D, Icepak, Maxwell 3D, and
	Mechanical.

[MaxJPRey]

LGTM.