docs:Added usage message for .distance-matrix.

antononcube · antononcube · commit e1abcee65392 · 2026-05-27T21:31:34.000-04:00
diff --git a/lib/Graph.rakumod b/lib/Graph.rakumod
@@ -738,6 +738,13 @@ class Graph
         }
     }
 
+    #======================================================
+    # Graph distance matrix
+    #======================================================
+    #| Give the matrix of distances between vertices for the graph object.
+    #| C<:$max-distance> -- Give the distances less or equal to $max-distance; others are put to Inf.
+    #| C<:$method> -- Method to use; one of "a-star", "dijkstra", "floyd-warshall", "unit-weight", or Whatever.
+    #| C<:$pairs> -- Whether to return vertex-vertex-to-distance pairs or not.
     method distance-matrix($max-distance = Whatever, :$method is copy = Whatever, Bool:D :p(:$pairs) = False) {
 
         die 'The first argument is expected to be an integer or Whatever.'

Original file line number	Diff line number	Diff line change
`@@ -738,6 +738,13 @@ class Graph`
`738`	`738`	`}`
`739`	`739`	`}`
`740`	`740`
	`741`	`+ #======================================================`
	`742`	`+ # Graph distance matrix`
	`743`	`+ #======================================================`
	`744`	`+ #\| Give the matrix of distances between vertices for the graph object.`
	`745`	`+ #\| C<:$max-distance> -- Give the distances less or equal to $max-distance; others are put to Inf.`
	`746`	`+ #\| C<:$method> -- Method to use; one of "a-star", "dijkstra", "floyd-warshall", "unit-weight", or Whatever.`
	`747`	`+ #\| C<:$pairs> -- Whether to return vertex-vertex-to-distance pairs or not.`
`741`	`748`	`method distance-matrix($max-distance = Whatever, :$method is copy = Whatever, Bool:D :p(:$pairs) = False) {`
`742`	`749`
`743`	`750`	`die 'The first argument is expected to be an integer or Whatever.'`