Update property descriptions for FunctionBasedPath

opensim-org · Sep 25, 2023 · 885fd34 · 885fd34
1 parent 4efa0f9
commit 885fd34
Showing 1 changed file with 14 additions and 11 deletions.
diff --git a/OpenSim/Simulation/Model/FunctionBasedPath.h b/OpenSim/Simulation/Model/FunctionBasedPath.h
@@ -128,21 +128,24 @@ OpenSim_DECLARE_CONCRETE_OBJECT(FunctionBasedPath, AbstractPath);
     OpenSim_DECLARE_LIST_PROPERTY(coordinate_paths, std::string, 
             "The list of paths to the model coordinates that are used as "
             "arguments to the length, lengthening speed, and moment arm "
-            "functions.");
+            "functions. You must provide a least one coordinate path, and "
+            "the order of the paths must match the order of the function "
+            "length function arguments.");
     OpenSim_DECLARE_OPTIONAL_PROPERTY(length_function, Function, 
-            "The OpenSim::Function object that computes the length of the path "
-            "as a function of the coordinate values. The function arguments "
-            "must match the order in the 'coordinates' property.");
+            "(Required) The OpenSim::Function object that computes the length "
+            "of the path as a function of the coordinate values. The function "
+            "arguments must match the order in the 'coordinates' property.");
     OpenSim_DECLARE_LIST_PROPERTY(moment_arm_functions, Function, 
-            "The list of OpenSim::Function objects that compute the moment "
-            "arms of the path as a function of the coordinate values. The "
-            "function arguments must match the order in the 'coordinates' "
+            "(Optional) The list of OpenSim::Function objects that compute the " 
+            "moment arms of the path as a function of the coordinate values. "
+            "The function arguments must match the order in the 'coordinates' "
             "property.");
     OpenSim_DECLARE_OPTIONAL_PROPERTY(lengthening_speed_function, Function, 
-            "The OpenSim::Function object that computes the speed of the path "
-            "as a function of the coordinate values and speeds. The function "
-            "arguments must be the coordinate values followed by coordinate "
-            "speeds, both matching the order in the 'coordinates' property.");
+            "(Optional) The OpenSim::Function object that computes the speed " 
+            "of the path as a function of the coordinate values and speeds. "
+            "The function arguments must be the coordinate values followed by "
+            "coordinate speeds, both matching the order in the 'coordinates' "
+            "property.");
 
 //=============================================================================
 // METHODS