diff --git a/.Rbuildignore b/.Rbuildignore index 78a1de5ef19..c45c4a77814 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -50,6 +50,8 @@ ^\.aviator/config\.yml$ ^src/vendor/cigraph/CITATION\.cff$ ^R/revdep\.R$ +^man/dot-igraph.progress\.Rd$ +^man/dot-igraph.status\.Rd$ ^man/dot-extract_constructor_and_modifiers\.Rd$ ^man/dot-apply_modifiers\.Rd$ ^man/handle_vertex_type_arg\.Rd$ diff --git a/NAMESPACE b/NAMESPACE index 1e24abca1f1..dc808ab248a 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -104,8 +104,6 @@ export("vertex_attr<-") export(.data) export(.env) export(.from) -export(.igraph.progress) -export(.igraph.status) export(.inc) export(.innei) export(.nei) diff --git a/R/console.R b/R/console.R index fc880c0ae3f..f69b1f63580 100644 --- a/R/console.R +++ b/R/console.R @@ -68,9 +68,9 @@ console <- function() { .igraph.pb <- NULL -#' @rdname console +#' igraph progress #' @param percent,message,clean Used internally by `.igraph.progress()` and `.igraph.status()` -#' @export +#' @dev .igraph.progress <- function(percent, message, clean = FALSE) { if (clean) { if (!is.null(.igraph.pb)) { @@ -90,8 +90,9 @@ console <- function() { } } -#' @rdname console -#' @export +#' igraph status +#' @inheritParams .igraph.progress +#' @dev .igraph.status <- function(message) { type <- igraph_opt("verbose") if (is.logical(type) && type) { diff --git a/man/console.Rd b/man/console.Rd index 4ae2d543bff..d2280ed140e 100644 --- a/man/console.Rd +++ b/man/console.Rd @@ -2,18 +2,9 @@ % Please edit documentation in R/console.R \name{console} \alias{console} -\alias{.igraph.progress} -\alias{.igraph.status} \title{The igraph console} \usage{ console() - -.igraph.progress(percent, message, clean = FALSE) - -.igraph.status(message) -} -\arguments{ -\item{percent, message, clean}{Used internally by \code{.igraph.progress()} and \code{.igraph.status()}} } \value{ \code{NULL}, invisibly. diff --git a/man/dot-igraph.progress.Rd b/man/dot-igraph.progress.Rd new file mode 100644 index 00000000000..faf598c5c63 --- /dev/null +++ b/man/dot-igraph.progress.Rd @@ -0,0 +1,15 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/console.R +\name{.igraph.progress} +\alias{.igraph.progress} +\title{igraph progress} +\usage{ +.igraph.progress(percent, message, clean = FALSE) +} +\arguments{ +\item{percent, message, clean}{Used internally by \code{.igraph.progress()} and \code{.igraph.status()}} +} +\description{ +igraph progress +} +\keyword{internal} diff --git a/man/dot-igraph.status.Rd b/man/dot-igraph.status.Rd new file mode 100644 index 00000000000..2ae44620bb0 --- /dev/null +++ b/man/dot-igraph.status.Rd @@ -0,0 +1,12 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/console.R +\name{.igraph.status} +\alias{.igraph.status} +\title{igraph status} +\usage{ +.igraph.status(message) +} +\description{ +igraph status +} +\keyword{internal}