docs: improve formatting

Author: salim-b

DESCRIPTION

@@ -78,7 +78,7 @@ Suggests:
     rsvg,
     ggridges
 LazyData: true
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 Config/Needs/check:

R/plotly.R

@@ -15,7 +15,8 @@
 #' 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] object.
+#' @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

R/plotly_data.R

@@ -87,16 +87,17 @@ print.plotly_data <- function(x, ...) {
 
 #' Highlight/query data based on primary key
 #' 
-#' 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].
+#' 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()].
 #' 
 #' @param x a plotly visualization or a `data.frame`.
-#' @param ... arguments passed to `crosstalk::SharedData$new()`
+#' @param ... arguments passed to
+#' [`crosstalk::SharedData$new()`][crosstalk::SharedData].
 #' @export
 #' @author Carson Sievert
-#' @return An object of class [crosstalk::SharedData]
+#' @return An object of class [`crosstalk::SharedData`][crosstalk::SharedData].
 #' @seealso [highlight]
 highlight_key <- function(x, ...) {
   UseMethod("highlight_key")