Fix draw_keypoints() documentation and error message typo#296
Merged
cregouby merged 1 commit intomlverse:mainfrom Mar 25, 2026
Merged
Fix draw_keypoints() documentation and error message typo#296cregouby merged 1 commit intomlverse:mainfrom
cregouby merged 1 commit intomlverse:mainfrom
Conversation
- connectivity: corrected type from Vector to List, replaced stale "(currently unavailable)" note with a proper description and example (list(c(1, 2), c(2, 3))) matching the implemented behaviour - colors: fixed copy-paste errors: "boxes" -> "keypoints" in two places, "viridis" -> "rainbow" (the function uses grDevices::rainbow()) - cli_abort() message: removed accidental duplicate "is" in the phrase "but is current shape is" -> "but current shape is"
Collaborator
|
Thanks a lot @srishtiii28 ! |
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
2 participants
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
Three documentation fixes for
draw_keypoints()inR/vision_utils.R:connectivityparameter: Changed type annotation fromVectortoList(it acceptslist(c(i, j), ...)pairs). Replaced the stale(currently unavailable)note with a real description and a concrete usage example, matching the implemented behaviour.colorsparameter: Fixed two copy-paste errors carried over fromdraw_bounding_boxes()—"boxes"→"keypoints"(twice), and"viridis"→"rainbow"(the function usesgrDevices::rainbow(), not viridis)."but is current shape is"→"but current shape is".All three fixes are applied in
R/vision_utils.R, reflected in the regeneratedman/draw_keypoints.Rd, and noted inNEWS.md.Files changed
R/vision_utils.R— roxygen2 source editsman/draw_keypoints.Rd— regenerated documentationNEWS.md— changelog entry under development version