docs: fix swapped preserve_order descriptions in resolve_matching_names docstrings

[dashitongzhi]

Description

Fixes #5146

The docstrings for both resolve_matching_names and resolve_matching_names_values in source/isaaclab/isaaclab/utils/string.py had the descriptions for preserve_order=True and preserve_order=False swapped.

Current (incorrect) docstring:

• preserve_order=True → "ordering is dictated by the order of the target strings"
• preserve_order=False → "ordering is the same as the order of the provided list of query regular expressions"

Actual code behavior (and examples):

• preserve_order=False → target list order (default, no reordering)
• preserve_order=True → query keys order (reordering occurs inside if preserve_order:)

The fix swaps the prose descriptions to match the actual code behavior and the provided examples.

Type of change

• Documentation fix (non-breaking change which fixes a docstring)

Checklist

• I have checked that there is no similar PR
• The code examples in the docstrings are correct and unchanged

[greptile-apps]

Greptile Summary

This PR fixes an inverted docstring in source/isaaclab/isaaclab/utils/string.py where the preserve_order=True and preserve_order=False descriptions were swapped in both resolve_matching_names and resolve_matching_names_values. The corrected descriptions now match the actual code logic and the provided examples.

• resolve_matching_names: Description for preserve_order=False (target-string order) and preserve_order=True (query-key order) are now correct.
• resolve_matching_names_values: Same swap applied — both functions now have accurate, consistent documentation.

Confidence Score: 5/5

Safe to merge — only docstring text is changed; no logic, behaviour, or interface is modified.

The change corrects two mirrored documentation errors. The actual implementation and all examples in the docstrings were already correct; only the prose descriptions for preserve_order=True and preserve_order=False were swapped. Reading the code confirms the fix is accurate for both functions.

No files require special attention.

Important Files Changed

Filename	Overview
source/isaaclab/isaaclab/utils/string.py	Swaps the swapped preserve_order=True/False descriptions in docstrings for resolve_matching_names and resolve_matching_names_values to match actual code behavior.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[resolve_matching_names / resolve_matching_names_values called] --> B{preserve_order?}
    B -- False default --> C[Return matches in target-string list order]
    B -- True --> D[Reorder results to follow query-key order]

Loading

_{Reviews (1): Last reviewed commit: "docs: fix swapped preserve_order descrip..." | Re-trigger Greptile}

[Copilot]

Pull request overview

Fixes incorrect docstring descriptions for the preserve_order parameter in resolve_matching_names and resolve_matching_names_values so the prose matches the functions’ actual ordering behavior.

Changes:

• Swapped the preserve_order=True vs preserve_order=False descriptions in resolve_matching_names docstring.
• Swapped the preserve_order=True vs preserve_order=False descriptions in resolve_matching_names_values docstring.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[dashitongzhi]

Friendly ping for review 🙏 This is a small, focused fix. CI is passing. Thank you!

[dashitongzhi]

Hi! 👋 This PR has passed all CI checks and looks ready for review. Could a maintainer please take a look when they have a chance? Thank you!