From 9e9ff6a9561d54f31b3e3031bc42f516e1a2392b Mon Sep 17 00:00:00 2001 From: Teun van den Brand <49372158+teunbrand@users.noreply.github.com> Date: Sun, 5 Nov 2023 16:19:46 +0100 Subject: [PATCH] Redocument `length` --- R/geom_arrow.R | 19 ++++++++++--------- man/geom_arrow.Rd | 17 ++++++++++------- man/geom_arrow_chain.Rd | 17 ++++++++++------- man/geom_arrow_curve.Rd | 17 ++++++++++------- man/geom_arrow_segment.Rd | 17 ++++++++++------- 5 files changed, 50 insertions(+), 37 deletions(-) diff --git a/R/geom_arrow.R b/R/geom_arrow.R index 83f902a..39dbbc8 100644 --- a/R/geom_arrow.R +++ b/R/geom_arrow.R @@ -12,15 +12,16 @@ #' @param arrow_head,arrow_fins,arrow_mid A function call to one of the #' [arrow ornament][arrow_ornaments] functions that can determine the shape #' of the arrow head, fins or middle (interior) arrows. -#' @param length_head,length_fins,length_mid Determines the length of the arrow -#' ornaments. Can be one of the following: -#' \describe{ -#' \item{A `numeric(1)` (default)}{to set the ornament size relative to -#' the linewidth of the shaft.} -#' \item{A `<`[`unit`][grid::unit]`>`}{to control the size in an absolute -#' manner. Behaviour of relative units such as `"npc"` or `"null"` is -#' undefined.} -#' } +#' @param length,length_head,length_fins,length_mid Determines the size of +#' the arrow ornaments. `length` sets the default length, whereas +#' `length_head`, `length_fins` and `length_mid` set the lengths of the +#' arrow head, arrow fins or middle arrows respectively. Can be one of the +#' following: +#' * A `` to set the ornament size relative to the `linewidth{_\*}` +#' settings. +#' * A [``][grid::unit] to control the ornament size in an absolute +#' manner. Behaviour of relative units such as `"npc"` or `"null"` is +#' undefined. #' @param resect,resect_head,resect_fins A `numeric(1)` denoting millimetres or #' `<`[`unit`][grid::unit]`>` to shorten the arrow. `resect_head` shortens #' the arrow from the arrow head side, whereas `resect_fins` shortens the diff --git a/man/geom_arrow.Rd b/man/geom_arrow.Rd index 622dd16..82cdaff 100644 --- a/man/geom_arrow.Rd +++ b/man/geom_arrow.Rd @@ -71,14 +71,17 @@ to the paired geom/stat.} \link[=arrow_ornaments]{arrow ornament} functions that can determine the shape of the arrow head, fins or middle (interior) arrows.} -\item{length_head, length_fins, length_mid}{Determines the length of the arrow -ornaments. Can be one of the following: -\describe{ -\item{A \code{numeric(1)} (default)}{to set the ornament size relative to -the linewidth of the shaft.} -\item{A \code{<}\code{\link[grid:unit]{unit}}\code{>}}{to control the size in an absolute +\item{length, length_head, length_fins, length_mid}{Determines the size of +the arrow ornaments. \code{length} sets the default length, whereas +\code{length_head}, \code{length_fins} and \code{length_mid} set the lengths of the +arrow head, arrow fins or middle arrows respectively. Can be one of the +following: +\itemize{ +\item A \verb{} to set the ornament size relative to the \verb{linewidth\{_\\*\}} +settings. +\item A \code{\link[grid:unit]{}} to control the ornament size in an absolute manner. Behaviour of relative units such as \code{"npc"} or \code{"null"} is -undefined.} +undefined. }} \item{justify}{A \code{numeric(1)} between [0-1] to control where the diff --git a/man/geom_arrow_chain.Rd b/man/geom_arrow_chain.Rd index 56c4414..363b18d 100644 --- a/man/geom_arrow_chain.Rd +++ b/man/geom_arrow_chain.Rd @@ -71,14 +71,17 @@ to the paired geom/stat.} \link[=arrow_ornaments]{arrow ornament} functions that can determine the shape of the arrow head, fins or middle (interior) arrows.} -\item{length_head, length_fins, length_mid}{Determines the length of the arrow -ornaments. Can be one of the following: -\describe{ -\item{A \code{numeric(1)} (default)}{to set the ornament size relative to -the linewidth of the shaft.} -\item{A \code{<}\code{\link[grid:unit]{unit}}\code{>}}{to control the size in an absolute +\item{length, length_head, length_fins, length_mid}{Determines the size of +the arrow ornaments. \code{length} sets the default length, whereas +\code{length_head}, \code{length_fins} and \code{length_mid} set the lengths of the +arrow head, arrow fins or middle arrows respectively. Can be one of the +following: +\itemize{ +\item A \verb{} to set the ornament size relative to the \verb{linewidth\{_\\*\}} +settings. +\item A \code{\link[grid:unit]{}} to control the ornament size in an absolute manner. Behaviour of relative units such as \code{"npc"} or \code{"null"} is -undefined.} +undefined. }} \item{justify}{A \code{numeric(1)} between [0-1] to control where the diff --git a/man/geom_arrow_curve.Rd b/man/geom_arrow_curve.Rd index 4767cae..80a5b91 100644 --- a/man/geom_arrow_curve.Rd +++ b/man/geom_arrow_curve.Rd @@ -87,14 +87,17 @@ to the paired geom/stat.} \link[=arrow_ornaments]{arrow ornament} functions that can determine the shape of the arrow head, fins or middle (interior) arrows.} -\item{length_head, length_fins, length_mid}{Determines the length of the arrow -ornaments. Can be one of the following: -\describe{ -\item{A \code{numeric(1)} (default)}{to set the ornament size relative to -the linewidth of the shaft.} -\item{A \code{<}\code{\link[grid:unit]{unit}}\code{>}}{to control the size in an absolute +\item{length, length_head, length_fins, length_mid}{Determines the size of +the arrow ornaments. \code{length} sets the default length, whereas +\code{length_head}, \code{length_fins} and \code{length_mid} set the lengths of the +arrow head, arrow fins or middle arrows respectively. Can be one of the +following: +\itemize{ +\item A \verb{} to set the ornament size relative to the \verb{linewidth\{_\\*\}} +settings. +\item A \code{\link[grid:unit]{}} to control the ornament size in an absolute manner. Behaviour of relative units such as \code{"npc"} or \code{"null"} is -undefined.} +undefined. }} \item{justify}{A \code{numeric(1)} between [0-1] to control where the diff --git a/man/geom_arrow_segment.Rd b/man/geom_arrow_segment.Rd index 8f6082e..bfff2ed 100644 --- a/man/geom_arrow_segment.Rd +++ b/man/geom_arrow_segment.Rd @@ -71,14 +71,17 @@ to the paired geom/stat.} \link[=arrow_ornaments]{arrow ornament} functions that can determine the shape of the arrow head, fins or middle (interior) arrows.} -\item{length_head, length_fins, length_mid}{Determines the length of the arrow -ornaments. Can be one of the following: -\describe{ -\item{A \code{numeric(1)} (default)}{to set the ornament size relative to -the linewidth of the shaft.} -\item{A \code{<}\code{\link[grid:unit]{unit}}\code{>}}{to control the size in an absolute +\item{length, length_head, length_fins, length_mid}{Determines the size of +the arrow ornaments. \code{length} sets the default length, whereas +\code{length_head}, \code{length_fins} and \code{length_mid} set the lengths of the +arrow head, arrow fins or middle arrows respectively. Can be one of the +following: +\itemize{ +\item A \verb{} to set the ornament size relative to the \verb{linewidth\{_\\*\}} +settings. +\item A \code{\link[grid:unit]{}} to control the ornament size in an absolute manner. Behaviour of relative units such as \code{"npc"} or \code{"null"} is -undefined.} +undefined. }} \item{justify}{A \code{numeric(1)} between [0-1] to control where the