Skip to content

Commit

Permalink
Fix incorrect doc for set
Browse files Browse the repository at this point in the history
  • Loading branch information
talgalili committed Jan 25, 2025
1 parent d38e65d commit e967a26
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ dendextend 1.19.1 (2025-01-25)
- Remove redundent `requireNamespace <- NULL`

## UPDATED DOCS:
- `set` - gave a bit more details about arguments when using `by_labels_branches_col`
- `set` - gave a bit more details (/fixes) about arguments when using `by_labels_branches_col`

dendextend 1.19.0 (2024-11-15)
==============================
Expand Down
6 changes: 4 additions & 2 deletions R/set.dendrogram.R
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,10 @@
#' might wish to perform on a dendrogram before plotting.
#'
#' The options of by_labels_branches_col, by_labels_branches_lwd, by_labels_branches_lty
#' have extra parameters: type, attr, TF_value, and by_lists_branches_col, by_lists_branches_lwd,
#' by_lists_branches_lty have extra parameters: attr, TF_value. You can read more about them here:
#' have extra parameters: `type` and `TF_value` (`attr` is autofilled).
#' For by_lists_branches_col, by_lists_branches_lwd,
#' by_lists_branches_lty, they get extra parameter: TF_value (`attr` is autofilled).
#' You can read more about them here:
#' \link{branches_attr_by_labels} and \link{branches_attr_by_lists}
#'
#' The "what" parameter" can accept the following options:
Expand Down
6 changes: 4 additions & 2 deletions man/set.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e967a26

Please sign in to comment.