Skip to content

Commit 6937fad

Browse files
committed
refactor: simplify roxygen2 syntax
1 parent 5d6c288 commit 6937fad

File tree

5 files changed

+12
-15
lines changed

5 files changed

+12
-15
lines changed

R/plotly.R

+1-2
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,12 @@
1515
#' help inform default axis/scale titles
1616
#' (e.g., `plot_ly(x = mtcars$wt)` vs `plot_ly(x = ~mtcars$wt)`)
1717
#'
18-
#' @param data A data frame (optional) or
19-
#' [`crosstalk::SharedData`][crosstalk::SharedData] object.
2018
#' @param ... Arguments (i.e., attributes) passed along to the trace `type`.
2119
#' See [schema()] for a list of acceptable attributes for a given trace `type`
2220
#' (by going to `traces` -> `type` -> `attributes`). Note that attributes
2321
#' provided at this level may override other arguments
2422
#' (e.g. `plot_ly(x = 1:10, y = 1:10, color = I("red"), marker = list(color = "blue"))`).
23+
#' @param data A data frame (optional) or [`crosstalk::SharedData`] object.
2524
#' @param type A character string specifying the trace type (e.g. `"scatter"`, `"bar"`, `"box"`, etc).
2625
#' If specified, it *always* creates a trace, otherwise
2726
#' @param name Values mapped to the trace's name attribute. Since a trace can

R/plotly_data.R

+5-5
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,17 @@ print.plotly_data <- function(x, ...) {
8787

8888
#' Highlight/query data based on primary key
8989
#'
90-
#' This function simply creates an object of class
91-
#' [`crosstalk::SharedData`][crosstalk::SharedData]. The reason it exists is to
92-
#' make it easier to teach others how to leverage its functionality in plotly.
93-
#' It also makes it more discoverable if one is already aware of [highlight()].
90+
#' This function simply creates an object of class [`crosstalk::SharedData`].
91+
#' The reason it exists is to make it easier to teach others how to leverage its
92+
#' functionality in plotly. It also makes it more discoverable if one is already
93+
#' aware of [highlight()].
9494
#'
9595
#' @param x a plotly visualization or a `data.frame`.
9696
#' @param ... arguments passed to
9797
#' [`crosstalk::SharedData$new()`][crosstalk::SharedData].
9898
#' @export
9999
#' @author Carson Sievert
100-
#' @return An object of class [`crosstalk::SharedData`][crosstalk::SharedData].
100+
#' @return An object of class [`crosstalk::SharedData`].
101101
#' @seealso [highlight]
102102
highlight_key <- function(x, ...) {
103103
UseMethod("highlight_key")

man/add_trace.Rd

+1-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/highlight_key.Rd

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/plot_ly.Rd

+1-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)