Add docstring to .edge method

GamesCrafters · Apr 8, 2024 · 40059d9 · 40059d9
1 parent 7123bf9
commit 40059d9
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/game/mock/builder.rs b/src/game/mock/builder.rs
@@ -76,7 +76,9 @@ impl<'a> SessionBuilder<'a> {
         }
     }
 
-    ///
+    /// Create a new directed edge between nodes `from` and `to`. Fails if
+    /// `from` is a terminal node, or if either `from` or `to` imply a player
+    /// count that is incompatible with existing nodes.
     pub fn edge(mut self, from: &'a Node, to: &'a Node) -> Result<Self> {
         if let Node::Terminal(_) = from {
             Err(MockViolation {