Skip to content

Commit 3da047f

Browse files
committed
Documentation fixes to avoid build warnings
1 parent 8954576 commit 3da047f

8 files changed

+39
-10
lines changed

R/plots.R

+4
Original file line numberDiff line numberDiff line change
@@ -1403,6 +1403,10 @@ setMethod("plot", signature(x = "MizerSim", y = "missing"),
14031403
#' level and predation mortality of each species through time. This method just
14041404
#' uses the other plotting functions and puts them all in one window.
14051405
#'
1406+
#' @param x An object of class \linkS4class{MizerParams}
1407+
#' @param y Not used
1408+
#' @param ... For additional arguments see the documentation for
1409+
#' [plotFeedingLevel()],[plotSpectra()],[plotPredMort()]
14061410
#' @return A viewport object
14071411
#' @export
14081412
#' @family plotting functions

R/validSpeciesParams.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
#' list of these functions).
5656
#'
5757
#' @param species_params The user-supplied species parameter data frame
58-
#' @return For validSpeciesParams(): A valid species parameter data frame with
58+
#' @return For `validSpeciesParams()`: A valid species parameter data frame with
5959
#' additional parameters with default values.
6060
#'
6161
#' @seealso [species_params()], [validGearParams()], [validParams()], [validSim()]
@@ -73,7 +73,7 @@ validSpeciesParams <- function(species_params) {
7373
}
7474

7575
#' @rdname validSpeciesParams
76-
#' @return For validGivenSpeciesParams(): A valid species parameter data frame
76+
#' @return For `validGivenSpeciesParams()`: A valid species parameter data frame
7777
#' without additional parameters.
7878
#' @export
7979
validGivenSpeciesParams <- function(species_params) {

docs/reference/completeSpeciesParams.html

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

docs/reference/plot-MizerParams-missing-method.html

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

docs/reference/validSpeciesParams.html

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

man/completeSpeciesParams.Rd

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

man/plot-MizerParams-missing-method.Rd

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

man/validSpeciesParams.Rd

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

0 commit comments

Comments
 (0)