Skip to content

fix: roxygen2 warnings and improve doc formatting #2388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
salim-b wants to merge 7 commits into
base: master
Choose a base branch
from
Open

fix: roxygen2 warnings and improve doc formatting #2388

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cc8c9a5
docs: improve formatting
salim-b Sep 4, 2024
61883a8
fix: remove ineffective `@inheritParams`
salim-b Sep 4, 2024
44ba0c0
fix: remove duplicated roxygen2 tags
salim-b Sep 4, 2024
5d6c288
fix: export S3 methods
salim-b Sep 4, 2024
6937fad
refactor: simplify roxygen2 syntax
salim-b Sep 15, 2024
9812dcd
Merge branch 'master' into fix-docs
salim-b Sep 11, 2025
a777067
Merge branch 'master' into fix-docs
salim-b Feb 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: remove ineffective @inheritParams 
it's senseless to inherit params from the same topic (same `@rdname`) and hence roxygen2 warns about it
  • Loading branch information
@salim-b
salim-b committed Sep 4, 2024
commit 61883a8d4381be90c304044b96983447fd366b19
2 changes: 0 additions & 2 deletions R/animate.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,6 @@ animation_opts_defaults <- function() {
}


#' @inheritParams animation_opts
#' @param hide remove the animation slider?
#' @param ... for `animation_slider`, attributes are passed to a special
#' layout.sliders object tied to the animation frames.
Expand All @@ -149,7 +148,6 @@ animation_slider <- function(p, hide = FALSE, ...) {
}


#' @inheritParams animation_slider
#' @param label a character string used for the animation button's label
#' @export
#' @rdname animation
Expand Down
1 change: 0 additions & 1 deletion R/orca.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ orca <- function(p, file = "plot.png", format = tools::file_ext(file),

#' Orca image export server
#'
#' @inheritParams orca
#' @param port Sets the server's port number.
#' @param keep_alive Turn on keep alive mode where orca will (try to) relaunch server if process unexpectedly exits.
#' @param window_max_number Sets maximum number of browser windows the server can keep open at a given time.
Expand Down