Skip to content

[Bug Report] resolve_matching_names (and resolve_matching_names_values) docstring has preserve_order=True/False descriptions swapped #5146

@jsw7460

Description

@jsw7460

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions