fix: correct inverted preserve_order docstring in resolve_matching_names#4678
Open
alltheseas wants to merge 1 commit intoisaac-sim:mainfrom
Open
fix: correct inverted preserve_order docstring in resolve_matching_names#4678alltheseas wants to merge 1 commit intoisaac-sim:mainfrom
alltheseas wants to merge 1 commit intoisaac-sim:mainfrom
Conversation
The docstring for `resolve_matching_names` incorrectly described the behavior of the `preserve_order` parameter — the descriptions for True and False were swapped. Fixes isaac-sim#4493 Signed-off-by: alltheseas <alltheseas@users.noreply.github.com>
Contributor
Greptile SummaryThis PR corrects the inverted Key changes:
The fix is verified by examining the implementation logic on lines 242-259, which shows that when Confidence Score: 5/5
Important Files Changed
Last reviewed commit: b4c20a0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix the inverted
preserve_orderparameter description in theresolve_matching_namesdocstring.The docstring incorrectly stated that
preserve_order=Truereturns results in list_of_strings order, andpreserve_order=Falsereturns in query-key order. The actual behavior is the opposite:preserve_order=False(default): results followlist_of_stringsorderpreserve_order=True: results are reordered to follow query regex key orderThis is the same bug that PR #4427 fixes for the sibling function
resolve_matching_names_values. This PR addresses the remaining function noted in #4493.Fixes #4493
Changes
True/Falsedescriptions in theresolve_matching_namesdocstring(default)annotation to theFalsecase for claritySigned-off-by: alltheseas alltheseas@users.noreply.github.com