Skip to content

Commit

Permalink
docs: Make documentation of disjoint_union() consistent with behavi…
Browse files Browse the repository at this point in the history
…or (#1641)
  • Loading branch information
krlmlr authored Dec 30, 2024
1 parent cdb0619 commit 93be2ae
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@
^R/revdep\.R$
^compile_commands\.json$
^\.cache$
^rchk$
^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$
^rchk$
7 changes: 4 additions & 3 deletions R/operators.R
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,11 @@ rename.attr.if.needed <- function(type, graphs, newsize = NULL, maps = NULL,
#' have completely disjoint graphs. Then a simple union is created. This
#' function can also be used via the `%du%` operator.
#'
#' `graph.disjont.union` handles graph, vertex and edge attributes. In
#' particular, it merges vertex and edge attributes using the basic `c()`
#' `disjoint_union()` handles graph, vertex and edge attributes. In
#' particular, it merges vertex and edge attributes using the [vctrs::vec_c()]
#' function. For graphs that lack some vertex/edge attribute, the corresponding
#' values in the new graph are set to `NA`. Graph attributes are simply
#' values in the new graph are set to a missing value (`NA` for scalar attributes,
#' `NULL` for list attributes). Graph attributes are simply
#' copied to the result. If this would result a name clash, then they are
#' renamed by adding suffixes: _1, _2, etc.
#'
Expand Down
1 change: 1 addition & 0 deletions igraph.Rproj
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Version: 1.0
ProjectId: ffa46ea4-a86f-4aac-9f09-64b2da845d3c

RestoreWorkspace: No
SaveWorkspace: No
Expand Down
2 changes: 1 addition & 1 deletion man/closeness.Rd

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

7 changes: 4 additions & 3 deletions man/disjoint_union.Rd

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

0 comments on commit 93be2ae

Please sign in to comment.