diff --git a/doc/XMLreference.rst b/doc/XMLreference.rst index c731b724..a25874c0 100644 --- a/doc/XMLreference.rst +++ b/doc/XMLreference.rst @@ -526,20 +526,16 @@ from its default. .. _option-flag-spring: :at:`spring`: :at-val:`[disable, enable], "enable"` - This flag disables passive joint and tendon springs. If passive :ref:`damper ` forces are - also disabled, *all* passive forces are disabled, including gravity compensation, fluid forces, forces computed by + also disabled, **all** passive forces are disabled, including gravity compensation, fluid forces, forces computed by the :ref:`mjcb_passive` callback, and forces computed by :ref:`plugins ` when passed the :ref:`mjPLUGIN_PASSIVE` capability flag. - , fluid dynamics forces, and custom passive - forces computed by the :ref:`mjcb_passive` callback. As a result, no passive forces are applied. - .. _option-flag-damper: :at:`damping`: :at-val:`[disable, enable], "enable"` This flag disables passive joint and tendon dampers. If passive :ref:`spring ` forces are also - disabled, *all* passive forces are disabled, including gravity compensation, fluid forces, forces computed by the + disabled, **all** passive forces are disabled, including gravity compensation, fluid forces, forces computed by the :ref:`mjcb_passive` callback, and forces computed by :ref:`plugins ` when passed the :ref:`mjPLUGIN_PASSIVE` capability flag. @@ -623,7 +619,7 @@ from its default. .. _option-flag-override: :at:`override`: :at-val:`[disable, enable], "disable"` - This flag enables to :ref:`Contact override ` mechanism explained above. + This flag enables the :ref:`Contact override ` mechanism. .. _option-flag-energy: diff --git a/doc/changelog.rst b/doc/changelog.rst index 8085e87e..d960749a 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -37,11 +37,11 @@ General - The ``mjDSBL_PASSIVE`` flag for disabling passive forces was removed and replaced by :ref:`mjDSBL_SPRING` and :ref:`mjDSBL_DAMPER` with corresponding :ref:`mjcf` :ref:`attributes`. Each flag disables only joint and tendon - springs or dampers, respectively. When both flags are set, *all* passive forces are disabled, including gravity + springs or dampers, respectively. When both flags are set, **all** passive forces are disabled, including gravity compensation, fluid forces, forces computed by the :ref:`mjcb_passive` callback, and forces computed by - :ref:`plugins ` when passed the :ref:`mjPLUGIN_PASSIVE` capability flag. Setting - both flags recovers the behavior of the previous flag and is the migration path for existing code using - ``mjDSBL_PASSIVE``. + :ref:`plugins ` when passed the :ref:`mjPLUGIN_PASSIVE` capability flag. + + **Migration:** Set both flags to recover the behavior of the previous flag. .. admonition:: Breaking ABI changes