Skip to content

Commit

Permalink
refactor: simplify roxygen2 syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
salim-b committed Sep 15, 2024
1 parent 5d6c288 commit f4e999f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions R/plotly_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,17 @@ print.plotly_data <- function(x, ...) {

#' Highlight/query data based on primary key
#'
#' This function simply creates an object of class
#' [`crosstalk::SharedData`][crosstalk::SharedData]. The reason it exists is to
#' make it easier to teach others how to leverage its functionality in plotly.
#' It also makes it more discoverable if one is already aware of [highlight()].
#' This function simply creates an object of class [`crosstalk::SharedData`].
#' The reason it exists is to make it easier to teach others how to leverage its
#' functionality in plotly. It also makes it more discoverable if one is already
#' aware of [highlight()].
#'
#' @param x a plotly visualization or a `data.frame`.
#' @param ... arguments passed to
#' [`crosstalk::SharedData$new()`][crosstalk::SharedData].
#' @export
#' @author Carson Sievert
#' @return An object of class [`crosstalk::SharedData`][crosstalk::SharedData].
#' @return An object of class [`crosstalk::SharedData`].
#' @seealso [highlight]
highlight_key <- function(x, ...) {
UseMethod("highlight_key")
Expand Down
8 changes: 4 additions & 4 deletions man/highlight_key.Rd

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

0 comments on commit f4e999f

Please sign in to comment.