diff --git a/man/create_uniform_reach_txt.Rd b/man/create_uniform_reach_txt.Rd index da7c02fc2cc814db1ea343961259707b60dbc428..30065759119b75bcb0263daffc3e185639f10f89 100644 --- a/man/create_uniform_reach_txt.Rd +++ b/man/create_uniform_reach_txt.Rd @@ -27,7 +27,7 @@ create_uniform_reach_txt( \item{section_names}{\link{character} vector of section names} -\item{singular}{\link{logical} \code{TRUE} for a singular section, \code{FALSE} for a regular section} +\item{singular}{\link{numeric} vector of abscissas of singular sections (See details)} } \value{ A \link{list} from which each item is a section exported by \link{create_section_txt}. @@ -36,6 +36,11 @@ Names of the list are the abscissas with trailing zeros for character sorting. \description{ Generate text export geometry for an uniform reach } +\details{ +The abscissas of the \code{singular} parameter should match with sections +abscissas defined by \code{abscissas}. \code{singular} values that don't match are silently +ignored. +} \examples{ # Trapezoidal section profT <- list(B = 2,S = 1, ZF = 100, ZB = 100 + 2)