fix: docstrings

Author: RobPasMue

src/ansys/additive/material_tuning.py

@@ -13,13 +13,15 @@
 class MaterialTuningInput:
     """Input parameters for tuning a custom material.
 
-    ``id: string``
+    Parameters
+    ----------
+    id: string
         User provided identifier for this simulation.
-    ``machine: AdditiveMachine``
+    machine: AdditiveMachine
         Machine related parameters.
-    ``material: AdditiveMaterial``
+    material: AdditiveMaterial
         Material used during simulation.
-    ``bead_length: float``
+    bead_length: float
         Length of bead to simulate (m).
     """
 
@@ -39,34 +41,26 @@ def __init__(
 
         Parameters
         ----------
-
         id: str
             Identifier for this set of tuning simulations.
-
         experiment_data_file: str
             Name of CSV file containing experimental results data.
-
         material_parameters_file: str
             Name of JSON file containing material parameters.
-
         thermal_properties_lookup_file: str
             Name of CSV file containing a lookup table for thermal dependent properties.
-
         characteristic_width_lookup_file: str
             Optional: Name of CSV file containing a lookup table for the characteristic melt pool
             width at a given temperature. If not provided, the characteristic width will be
             calculated and ``base_plate_temperature`` must be provided.
             Default is None.
-
         allowable_error: float
             Maximum allowable error between experimental and simulated results.
             Default is 0.05 (5%).
-
         max_iterations: int
             Maximum number of iterations to perform when trying to match
             simulation results to an experiment if the allowable error is not met.
             Default is 15.
-
         base_plate_temperature: float
             Temperature of the base plate in Kelvin. This is only required if
             ``characteristic_width_lookup_file`` is ``None``. It is ignored otherwise.

src/ansys/additive/porosity.py

@@ -10,17 +10,19 @@
 class PorosityInput:
     """Input parameters for porosity simulation.
 
-    ``id: string``
+    Parameters
+    ----------
+    id: string
         User provided identifier for this simulation.
-    ``size_x: float``
+    size_x: float
         Size of simulated sample in x dimension (m), valid values: 0.001 to 0.01.
-    ``size_y: float``
+    size_y: float
         Size of simulated sample in y dimension (m), valid values: 0.001 to 0.01.
-    ``size_z: float``
+    size_z: float
         Size of simulated sample in z dimension (m), valid values: 0.001 to 0.01.
-    ``machine: AdditiveMachine``
+    machine: AdditiveMachine
         Machine related parameters.
-    ``material: AdditiveMaterial``
+    material: AdditiveMaterial
         Material used during simulation.
     """
 

src/ansys/additive/server_utils.py

@@ -15,10 +15,8 @@ def launch_server(port: int, cwd: str = USER_DATA_PATH) -> subprocess.Popen:
 
     Parameters
     ----------
-
     port: int
         Port number to use for gRPC connections.
-
     cwd: str
         Current working directory to use for the server process.