Skip to content

fix: correct inverted preserve_order docstring in resolve_matching_names #4678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alltheseas wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −8
Open

fix: correct inverted preserve_order docstring in resolve_matching_names #4678

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions source/isaaclab/isaaclab/utils/string.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,17 +183,18 @@ def resolve_matching_names(
When a list of query regular expressions is provided, the function checks each target string against each
query regular expression and returns the indices of the matched strings and the matched strings.

If the :attr:`preserve_order` is True, the ordering of the matched indices and names is the same as the order
of the provided list of strings. This means that the ordering is dictated by the order of the target strings
and not the order of the query regular expressions.
If the :attr:`preserve_order` is False (default), the ordering of the matched indices and names follows
the order of the provided list of strings. This means that the ordering is dictated by the order of the
target strings and not the order of the query regular expressions.

If the :attr:`preserve_order` is False, the ordering of the matched indices and names is the same as the order
of the provided list of query regular expressions.
If the :attr:`preserve_order` is True, the ordering of the matched indices and names follows the order
of the query regular expressions.

For example, consider the list of strings is ['a', 'b', 'c', 'd', 'e'] and the regular expressions are ['a|c', 'b'].
If :attr:`preserve_order` is False, then the function will return the indices of the matched strings and the
strings as: ([0, 1, 2], ['a', 'b', 'c']). When :attr:`preserve_order` is True, it will return them as:
([0, 2, 1], ['a', 'c', 'b']).
If :attr:`preserve_order` is False (default), then the function will return the indices of the matched strings and
the strings as: ([0, 1, 2], ['a', 'b', 'c']) - following the order of list_of_strings. When
:attr:`preserve_order` is True, it will return them as:
([0, 2, 1], ['a', 'c', 'b']) - following the order of the regex keys.

Note:
The function does not sort the indices. It returns the indices in the order they are found.
Expand Down