Skip to content

Commit

Permalink
Merge pull request #147 from salim-b/patch-1
Browse files Browse the repository at this point in the history
Tweak `verbatim_logical()` doc
  • Loading branch information
spgarbet authored Jul 15, 2024
2 parents bcd0b4b + 854e0bc commit 5a80afa
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions man/verbatim_logical.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@
\alias{verbatim_logical}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{
Alternalte logical handler
Alternative logical handler
}
\description{
A yaml handler function that will cause logical vectors to emit true/false value
instead of yes/no value
A yaml handler function that causes logical vectors to emit
\code{true}/\code{false} instead of \code{yes}/\code{no} values.
}
\usage{
verbatim_logical(x)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{x}{
logical values to convert to \code{true} or \code{false}.
logical vector to convert to \code{true}/\code{false}.
}
}
\details{
To use pass into as.yaml as part of a handler arguement list like
\code{list(logical=verbatim_logical)}.
Pass this function to \code{\link[=as.yaml]{as.yaml()}} as part of the
\code{handler} argument list like \code{list(logical = verbatim_logical)}.
}
\value{
Returns a vector of strings of either \code{true} or \code{false} of class
Expand Down

0 comments on commit 5a80afa

Please sign in to comment.