doc: clarify weights use in layout_with_kk()

igraph · Feb 3, 2025 · d9ef523 · d9ef523
1 parent 16896de
commit d9ef523
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 10 deletions.
diff --git a/R/layout.R b/R/layout.R
@@ -1491,9 +1491,9 @@ with_graphopt <- function(...) layout_spec(layout_with_graphopt, ...)
 #'   iterations.
 #' @param kkconst Numeric scalar, the Kamada-Kawai vertex attraction constant.
 #'   Typical (and default) value is the number of vertices.
-#' @param weights Edge weights, larger values will result longer edges.
-#'   Note that this is opposite to [layout_with_fr()]. Weights must
-#'   be positive.
+#' @param weights Edge weights, larger values will result in longer edges.
+#'   Note that this is the opposite of [layout_with_fr()], which produces
+#'   shorter edges for larger weights. Weights must be positive.
 #' @param minx If not `NULL`, then it must be a numeric vector that gives
 #'   lower boundaries for the \sQuote{x} coordinates of the vertices. The length
 #'   of the vector must match the number of vertices in the graph.

diff --git a/man/get.edge.ids.Rd b/man/get.edge.ids.Rd
diff --git a/man/get_edge_ids.Rd b/man/get_edge_ids.Rd
diff --git a/man/layout_with_kk.Rd b/man/layout_with_kk.Rd