add note about parentscope

baggepinnen · baggepinnen · commit 506a4c43377d · 2024-09-23T05:48:54.000+02:00
diff --git a/docs/src/examples/suspension.md b/docs/src/examples/suspension.md
@@ -297,7 +297,8 @@ The connection between the wheels and the ground form two kinematic loops togeth
             x0 = 0.0,
             z0 = 0.0,
             der_angles = [0, 0, 0],
-            iscut = true, # NOTE: Only used since while we have an "upright joint"
+            iscut = true,
+            # Note the ParentScope qualifier, without this, the parameters are treated as belonging to the wheel.wheel_joint component instead of the ExcitedWheelAssembly
             surface = (x,z)->ParentScope(ParentScope(amplitude))*(sin(2pi*ParentScope(ParentScope(freq))*t)), # Excitation from a time-varying surface profile
         )
 

Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,8 @@ The connection between the wheels and the ground form two kinematic loops togeth`
`297`	`297`	`x0 = 0.0,`
`298`	`298`	`z0 = 0.0,`
`299`	`299`	`der_angles = [0, 0, 0],`
`300`		`- iscut = true, # NOTE: Only used since while we have an "upright joint"`
	`300`	`+ iscut = true,`
	`301`	`+ # Note the ParentScope qualifier, without this, the parameters are treated as belonging to the wheel.wheel_joint component instead of the ExcitedWheelAssembly`
`301`	`302`	`surface = (x,z)->ParentScope(ParentScope(amplitude))(sin(2piParentScope(ParentScope(freq))*t)), # Excitation from a time-varying surface profile`
`302`	`303`	`)`
`303`	`304`