refactor: simplify roxygen2 syntax

plotly · salim-b · Sep 4, 2024 · Sep 4, 2024 · Sep 4, 2024 · Sep 4, 2024
commit 6937fadb1a6a6ea96be1cf4cde8538cdafce0ab8
diff --git a/R/plotly.R b/R/plotly.R
@@ -15,13 +15,12 @@
 #' help inform default axis/scale titles
 #' (e.g., `plot_ly(x = mtcars$wt)` vs `plot_ly(x = ~mtcars$wt)`)
 #'
-#' @param data A data frame (optional) or
-#' [`crosstalk::SharedData`][crosstalk::SharedData] object.
 #' @param ... Arguments (i.e., attributes) passed along to the trace `type`.
 #' See [schema()] for a list of acceptable attributes for a given trace `type`
 #' (by going to `traces` -> `type` -> `attributes`). Note that attributes
 #' provided at this level may override other arguments 
 #' (e.g. `plot_ly(x = 1:10, y = 1:10, color = I("red"), marker = list(color = "blue"))`).
+#' @param data A data frame (optional) or [`crosstalk::SharedData`] object.
 #' @param type A character string specifying the trace type (e.g. `"scatter"`, `"bar"`, `"box"`, etc).
 #' If specified, it *always* creates a trace, otherwise 
 #' @param name Values mapped to the trace's name attribute. Since a trace can 

diff --git a/R/plotly_data.R b/R/plotly_data.R
@@ -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")

diff --git a/man/add_trace.Rd b/man/add_trace.Rd
diff --git a/man/highlight_key.Rd b/man/highlight_key.Rd
diff --git a/man/plot_ly.Rd b/man/plot_ly.Rd