Skip to content

Commit bed1cdc

Browse files
committed
Update changelog fragment for cfg_factory-based shim
1 parent dc919a7 commit bed1cdc

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

source/isaaclab_tasks/changelog.d/jichuanh-cartpole-presets.minor.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Added
1313
* Added :func:`isaaclab_tasks.utils.deprecated_task_alias` -- factory
1414
that wraps a retired gym task ID with a :class:`DeprecationWarning`
1515
naming the consolidated task plus its equivalent CLI tokens, and
16-
lazily resolves the cfg variant at ``gym.make`` time.
16+
delegates cfg construction to a caller-supplied ``cfg_factory``.
1717

1818
Deprecated
1919
^^^^^^^^^^
@@ -23,5 +23,12 @@ Deprecated
2323
showcase) in favor of the four consolidated tasks above. Each retired
2424
ID still loads and emits a :class:`DeprecationWarning` naming the
2525
consolidated task and the equivalent ``presets=<name>`` (plus
26-
``--agent=<entry_point_name>`` where required) invocation. Full
27-
migration table is in the PR description.
26+
``--agent=<entry_point_name>`` where required) invocation. The shims
27+
return the historical per-variant cfg subclass verbatim so retired
28+
IDs stay bit-for-bit identical to their pre-deprecation behavior;
29+
only the deprecation warning is layered on top. The historical
30+
subclasses (e.g. ``CartpoleRGBCameraEnvCfg``,
31+
``CartpoleAlbedoCameraEnvCfg``, ``BoxBoxEnvCfg``, ...) are kept for
32+
one release alongside the consolidated cfgs and will be removed
33+
together with the retired task IDs. Full migration table is in the
34+
PR description.

0 commit comments

Comments
 (0)