docs: standardization of docstrings (#1271)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: mhoeijm

doc/source/changelog/1271.documentation.md

@@ -0,0 +1 @@
+Standardization of docstrings

src/ansys/health/heart/logger.py

@@ -534,8 +534,7 @@ def addfile_handler(logger, filename=FILE_NAME, level=LOG_LEVEL_STDOUT, write_he
     filename : str, default: FILE_NAME
         Name of the output file, which is ``'pyconv-de.log'`` by default.
     level : int, default: 10
-        Level of logging. The default is ``10``, in which case the
-        ``logging.DEBUG`` level is used.
+        Level of logging. ``10`` corresponds to ``logging.DEBUG`` level.
     write_headers : bool, default: False
         Whether to write headers to the file.
 

src/ansys/health/heart/models.py

@@ -255,7 +255,7 @@ def __init__(self, working_directory: pathlib.Path | str = None) -> None:
 
         #! TODO: non-functional flag. Remove or replace.
         self._add_blood_pool: bool = False
-        """Flag indicating whether a blood pool mesh is added. (Experimental)"""
+        """Flag indicating whether a blood pool mesh is added. (Experimental)."""
 
         self._input: _InputModel = None
         """Input model."""
@@ -396,7 +396,7 @@ def create_part_by_ids(
         name : str
             Part name.
         part_type : anatomy._PartType, default: anatomy._PartType.UNDEFINED
-            Type of the part. The default is ``anatomy._PartType.UNDEFINED``.
+            Type of the part to create.
 
         Returns
         -------
@@ -711,8 +711,7 @@ def plot_fibers(self, n_seed_points: int = 1000):
         plot_raw_mesh : bool, default: False
             Whether to plot the streamlines on the raw mesh.
         n_seed_points : int, default: 1000
-            Number of seed points. While the default is ``1000``, using ``5000``
-            is recommended.
+            Number of seed points for mesh generation. Using ``5000`` is recommended.
 
         Examples
         --------

src/ansys/health/heart/post/laplace_post.py

@@ -169,8 +169,8 @@ def compute_la_fiber_cs(
     settings : AtrialFiber
         Atrial fiber settings.
     endo_surface : pv.PolyData, default: None
-        ``_description_``. If given, normal direction is updated by the surface
-        normal instead of the Laplace solution.
+        Endocardium surface mesh. If provided, normal direction is updated by the
+        surface normal instead of the Laplace solution.
 
     Notes
     -----
@@ -249,8 +249,8 @@ def compute_ra_fiber_cs(
     settings : AtrialFiber
         Atrial fiber settings.
     endo_surface : pv.PolyData, default: None
-        ``_description_``. If given, normal direction is updated by the surface normal
-        instead of the Laplace solution.
+        Endocardium surface mesh. If provided, normal direction is updated by the
+        surface normal instead of the Laplace solution.
 
     Notes
     -----

src/ansys/health/heart/settings/settings.py

@@ -793,10 +793,10 @@ class FibersDRBM(BaseSettings):
         beta_epi=Quantity(20, "degree"))
         Fiber orientation settings specific to the right ventricle.
         Contains alpha and beta angles for right ventricular wall.
-    alpha_outflow_tract : Quantity or None, default: None
+    alpha_outflow_tract : Quantity | None, default: None
         Helical angle for the outflow tract region in degrees.
         Set to None if outflow tract fiber orientation not specified.
-    beta_outflow_tract : Quantity or None, default: None
+    beta_outflow_tract : Quantity | None, default: None
         Inclination angle for the outflow tract region in degrees.
         Set to None if outflow tract fiber orientation not specified.
     septal_fraction : float, default: 2.0/3.0

src/ansys/health/heart/writer/custom_keywords/keywords/control_implicit_solver.py

@@ -28,7 +28,7 @@
 
 
 class ControlImplicitSolver(KeywordBase):
-    """LS-DYNA CONTROL_IMPLICIT_SOLVER keyword"""
+    """LS-DYNA CONTROL_IMPLICIT_SOLVER keyword."""
 
     keyword = "CONTROL"
     subkeyword = "IMPLICIT_SOLVER"

src/ansys/health/heart/writer/custom_keywords/keywords/em_boundary_prescribed.py

@@ -27,7 +27,7 @@
 
 
 class EmBoundaryPrescribed(KeywordBase):
-    """LS-DYNA EM_BOUNDARY_PRESCRIBED keyword"""
+    """LS-DYNA EM_BOUNDARY_PRESCRIBED keyword."""
 
     keyword = "EM"
     subkeyword = "BOUNDARY_PRESCRIBED"

src/ansys/health/heart/writer/custom_keywords/keywords/em_control_ep.py

@@ -25,7 +25,7 @@
 
 
 class EmControlEp(KeywordBase):
-    """LS-DYNA EM_CONTROL_EP keyword"""
+    """LS-DYNA EM_CONTROL_EP keyword."""
 
     keyword = "EM"
     subkeyword = "CONTROL_EP"

src/ansys/health/heart/writer/custom_keywords/keywords/em_ep_cellmodel_tomek.py

@@ -25,7 +25,7 @@
 
 
 class EmEpCellmodelTomek(KeywordBase):
-    """LS-DYNA EM_EP_CELLMODEL_TOMEK keyword"""
+    """LS-DYNA EM_EP_CELLMODEL_TOMEK keyword."""
 
     keyword = "EM"
     subkeyword = "EP_CELLMODEL_TOMEK"

src/ansys/health/heart/writer/custom_keywords/keywords/em_ep_createfiberorientation.py

@@ -28,7 +28,7 @@
 
 
 class EmEpCreatefiberorientation(KeywordBase):
-    """LS-DYNA EM_EP_CREATEFIBERORIENTATION keyword"""
+    """LS-DYNA EM_EP_CREATEFIBERORIENTATION keyword."""
 
     keyword = "EM"
     subkeyword = "EP_CREATEFIBERORIENTATION"