From 515f5797343b76816fdba5476db3e9ec5db5c60d Mon Sep 17 00:00:00 2001 From: Luuk van der Meer Date: Thu, 27 Oct 2022 10:47:50 +0200 Subject: [PATCH] docs: Document return value of plot method :books: --- R/plot.R | 2 ++ man/plot.sfnetwork.Rd | 3 +++ 2 files changed, 5 insertions(+) diff --git a/R/plot.R b/R/plot.R index 3a208ecd..5f7e82d5 100644 --- a/R/plot.R +++ b/R/plot.R @@ -16,6 +16,8 @@ #' as can be found in \code{sf}, \code{tmap}, \code{ggplot2}, \code{ggspatial}, #' and others. #' +#' @return This is a plot method and therefore has no visible return value. +#' #' @examples #' oldpar = par(no.readonly = TRUE) #' par(mar = c(1,1,1,1), mfrow = c(1,1)) diff --git a/man/plot.sfnetwork.Rd b/man/plot.sfnetwork.Rd index ab9235e0..b814dd3f 100644 --- a/man/plot.sfnetwork.Rd +++ b/man/plot.sfnetwork.Rd @@ -15,6 +15,9 @@ Ignored when the edges of the network are spatially explicit.} \item{...}{Arguments passed on to \code{\link[sf:plot]{plot.sf}}} } +\value{ +This is a plot method and therefore has no visible return value. +} \description{ Plot the geometries of an object of class \code{\link{sfnetwork}}. }