Skip to content

Commit

Permalink
docs: use {devtag} for internal function docs (#1507)
Browse files Browse the repository at this point in the history
  • Loading branch information
aviator-app[bot] authored Sep 19, 2024
2 parents 138edc9 + ac9d767 commit 8c7d368
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,6 @@
^\.aviator/config\.yml$
^src/vendor/cigraph/CITATION\.cff$
^R/revdep\.R$
^man/dot-extract_constructor_and_modifiers\.Rd$
^man/dot-apply_modifiers\.Rd$
^man/handle_vertex_type_arg\.Rd$
5 changes: 2 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,14 @@ LinkingTo:
cpp11 (>= 0.5.0)
VignetteBuilder:
knitr
Config/Needs/build: roxygen2, devtools, irlba, pkgconfig, igraph/igraph.r2cdocs
Config/Needs/build: roxygen2, devtools, irlba, pkgconfig, igraph/igraph.r2cdocs, maelle/devtag@keywords-internal
Config/Needs/coverage: covr
Config/Needs/website: readr
Config/testthat/edition: 3
Config/testthat/parallel: true
Config/testthat/start-first: vs-es, scan, vs-operators, weakref,
watts.strogatz.game
Encoding: UTF-8
Roxygen: list(markdown = TRUE, roclets = c("collate", "rd", "namespace",
"igraph.r2cdocs::cdocs_roclet"), packages = "igraph.r2cdocs")
Roxygen: list(markdown = TRUE, roclets = c("collate", "rd", "namespace", "igraph.r2cdocs::cdocs_roclet", "devtag::dev_roclet"), packages = "igraph.r2cdocs")
RoxygenNote: 7.3.2
SystemRequirements: libxml2 (optional), glpk (>= 4.57, optional)
6 changes: 2 additions & 4 deletions R/make.R
Original file line number Diff line number Diff line change
Expand Up @@ -664,11 +664,10 @@ graph.atlas <- function(n) { # nocov start
#' @param .variant Constructor variant; must be one of \sQuote{make},
#' \sQuote{graph} or \sQuote{sample}. Used in cases when the same constructor
#' specification has deterministic and random variants.
#' @family constructor modifiers
#' @return A named list with three items: \sQuote{cons} for the constructor
#' function, \sQuote{mods} for the modifiers and \sQuote{args} for the
#' remaining, unparsed arguments.
#' @noRd
#' @dev
.extract_constructor_and_modifiers <- function(..., .operation, .variant) {
args <- list(...)
cidx <- vapply(args, inherits, TRUE, what = "igraph_constructor_spec")
Expand Down Expand Up @@ -715,9 +714,8 @@ graph.atlas <- function(n) { # nocov start
#'
#' @param graph The graph to apply the modifiers to
#' @param mods The modifiers to apply
#' @family constructor modifiers
#' @return The modified graph
#' @noRd
#' @dev
.apply_modifiers <- function(graph, mods) {
for (m in mods) {
if (m$id == "without_attr") {
Expand Down
2 changes: 1 addition & 1 deletion R/other.R
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ sample_seq <- function(low, high, length) {
#' @return A logical vector representing the resolved vertex type for each
#' vertex in the graph
#' @author Tamas Nepusz \email{ntamas@@gmail.com}
#' @keywords internal
#' @dev
#'
handle_vertex_type_arg <- function(types, graph, required = T) {
if (is.null(types) && "type" %in% vertex_attr_names(graph)) {
Expand Down
21 changes: 21 additions & 0 deletions man/dot-apply_modifiers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 29 additions & 0 deletions man/dot-extract_constructor_and_modifiers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8c7d368

Please sign in to comment.