Describe the bug
The resolve_matching_names function in source/isaaclab/isaaclab/utils/string.py has the preserve_order parameter descriptions inverted in the docstring relative to actual code behavior.
Docstring claims (lines 186–191):
preserve_order=True → target list order
preserve_order=False → query keys order
Actual code behavior (line 242):
preserve_order=True → query keys order (reordering occurs inside if preserve_order:)
preserve_order=False → target list order (no reordering; outer loop iterates over target)
The example results (lines 193–196) are correct, but the prose descriptions explaining them are inverted.
The same issue exists in resolve_matching_names_values.
Describe the bug
The
resolve_matching_namesfunction insource/isaaclab/isaaclab/utils/string.pyhas thepreserve_orderparameter descriptions inverted in the docstring relative to actual code behavior.Docstring claims (lines 186–191):
preserve_order=True→ target list orderpreserve_order=False→ query keys orderActual code behavior (line 242):
preserve_order=True→ query keys order (reordering occurs insideif preserve_order:)preserve_order=False→ target list order (no reordering; outer loop iterates over target)The example results (lines 193–196) are correct, but the prose descriptions explaining them are inverted.
The same issue exists in
resolve_matching_names_values.