fix: correct misleading comments and docs in BinaryJointAction#4679
fix: correct misleading comments and docs in BinaryJointAction#4679alltheseas wants to merge 2 commits 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>
The inline comments in process_actions stated "true: close, false: open" which describes the binary_mask variable but reads as describing the action convention, contradicting actual behavior. Also fix class docstring: "positive" -> "non-negative" for float actions, since zero maps to open (the mask uses < 0, not <= 0). Fixes isaac-sim#4670 Signed-off-by: alltheseas <alltheseas@users.noreply.github.com>
Greptile SummaryThis PR fixes misleading documentation in two areas:
Both changes are documentation-only with no behavioral impact. The code logic remains unchanged and functions correctly. Confidence Score: 5/5
Important Files Changed
Last reviewed commit: 3e0f702 |
Summary
Fix misleading inline comments and an imprecise docstring in
BinaryJointAction.process_actions.# true: close, false: open, which describes thebinary_maskvariable but reads as describing the action convention — the opposite of actual behavior< 0, so zero maps to open. Updated to "non-negative values"No behavior change. Comments and docs now match the code.
Fixes #4670
Changes
source/isaaclab/isaaclab/envs/mdp/actions/binary_joint_actions.pySigned-off-by: alltheseas alltheseas@users.noreply.github.com