cran: add missing value in doc

FRBCesab · Oct 13, 2023 · 665a01f · 665a01f
1 parent d669e2b
commit 665a01f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/R/append_edge_lists.R b/R/append_edge_lists.R
@@ -6,7 +6,12 @@
 #' 
 #' @param ... one or several edge lists `data.frame`. Outputs of the function
 #'   [create_edge_list()].
-#'   
+#' 
+#' @return A `data.frame` with `n` rows (where `n` is the total number of edges)
+#' and the following two columns:
+#' - `from`: the node label of one of the two endpoints of the edge
+#' - `to`: the node label of the other endpoint of the edge
+#' 
 #' @export
 #' 
 #' @examples

diff --git a/man/append_edge_lists.Rd b/man/append_edge_lists.Rd