Skip to content

Commit cfb510f

Browse files
committed
improve documentation
1 parent c35064e commit cfb510f

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

docs/source/overview/core-concepts/actuators.rst

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,13 +164,27 @@ and marked as deprecated. This preserves same behavior as they did in v1.4.0. Ev
164164
Users who want to tune the underlying physics-solver limits should set the ``_sim`` flags.
165165

166166

167-
USD vs. ActuatorCfg Resolution
168-
-------------------------------
167+
USD vs. ActuatorCfg discrepancy resolution
168+
------------------------------------------
169169

170-
USD having default value and ActuatorCfg can be specified with None, or a different value from USD can sometime be
171-
confusing what exactly gets written into simulation. To help clarify that, we designed a flag
172-
:attr:`~isaaclab.assets.ArticulationCfg.actuator_value_resolution_debug_print`, to help user figure
173-
out what exact value gets used in simulation.
170+
USD having default value and the fact that ActuatorCfg can be specified with None, or a overriding value can sometime be
171+
confusing what exactly gets written into simulation. The resolution follows these simple rules,per joint and per
172+
property:
173+
174+
.. table:: Resolution Rules for USD vs. ActuatorCfg
175+
176+
+------------------------+------------------------+--------------------+
177+
| **Condition** | **ActuatorCfg Value** | **Applied** |
178+
+========================+========================+====================+
179+
| No override provided | Not Specified | USD Value |
180+
+------------------------+------------------------+--------------------+
181+
| Override provided | User's ActuatorCfg | Same as ActuatorCfg|
182+
+------------------------+------------------------+--------------------+
183+
184+
185+
Digging into USD can sometime be unconvinent, to help clarify what exact value is written, we designed a flag
186+
:attr:`~isaaclab.assets.ArticulationCfg.actuator_value_resolution_debug_print`,
187+
to help user figure out what exact value gets used in simulation.
174188

175189
Whenever an actuator parameter is overridden in the user's ActuatorCfg (or left unspecified),
176190
we compare it to the value read from the USD definition and record any differences. For each joint and each property,

0 commit comments

Comments
 (0)