improved the documentation of the get_original_densities methods

ami-iit · Mar 12, 2024 · 5d2252d · 5d2252d
1 parent 67a9e7d
commit 5d2252d
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/src/adam/parametric/casadi/computations_parametric.py b/src/adam/parametric/casadi/computations_parametric.py
@@ -262,10 +262,10 @@ def get_total_mass(self) -> cs.Function:
         )
 
     def get_original_densities(self) -> List[float]:
-        """Returns the original densities of the links
+        """Returns the original densities of the parametric links
 
         Returns:
-            densities: The original densities
+            densities: The original densities of the parametric links
         """
         densities = []
         model = self.rbdalgos.model

diff --git a/src/adam/parametric/jax/computations_parametric.py b/src/adam/parametric/jax/computations_parametric.py
@@ -450,10 +450,10 @@ def get_total_mass(
         return self.rbdalgos.get_total_mass()
 
     def get_original_densities(self) -> List[float]:
-        """Returns the original densities of the links
+        """Returns the original densities of the parametric links
 
         Returns:
-            densities: The original densities
+            densities: The original densities of the parametric links
         """
         densities = []
         model = self.rbdalgos.model

diff --git a/src/adam/parametric/numpy/computations_parametric.py b/src/adam/parametric/numpy/computations_parametric.py
@@ -444,10 +444,10 @@ def get_total_mass(
         return self.rbdalgos.get_total_mass()
 
     def get_original_densities(self) -> List[float]:
-        """Returns the original densities of the links
+        """Returns the original densities of the parametric links
 
         Returns:
-            densities: The original densities
+            densities: The original densities of the parametric links
         """
         densities = []
         model = self.rbdalgos.model

diff --git a/src/adam/parametric/pytorch/computations_parametric.py b/src/adam/parametric/pytorch/computations_parametric.py
@@ -448,10 +448,10 @@ def get_total_mass(
         return self.rbdalgos.get_total_mass()
 
     def get_original_densities(self) -> List[float]:
-        """Returns the original densities of the links
+        """Returns the original densities of the parametric links
 
         Returns:
-            densities: The original densities
+            densities: The original densities of the parametric links
         """
         densities = []
         model = self.rbdalgos.model