Docs typos (#46)

Author: matth2k

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "safety-net"
-version = "0.2.1"
+version = "0.2.2"
 edition = "2024"
 license = "MIT OR Apache-2.0"
 

src/graph.rs

@@ -27,9 +27,9 @@ where
 
 /// A table that maps nets to the circuit nodes they drive
 pub struct FanOutTable<'a, I: Instantiable> {
-    // A reference to the underlying netlist
+    /// A reference to the underlying netlist
     _netlist: &'a Netlist<I>,
-    // Maps a net to the list of nodes it drives
+    /// Maps a net to the list of nodes it drives
     net_fan_out: HashMap<Net, Vec<NetRef<I>>>,
     /// Maps a node to the list of nodes it drives
     node_fan_out: HashMap<NetRef<I>, Vec<NetRef<I>>>,
@@ -114,9 +114,9 @@ where
 /// An simple example to analyze the logic levels of a netlist.
 /// This analysis checks for cycles, but it doesn't check for registers.
 pub struct SimpleCombDepth<'a, I: Instantiable> {
-    // A reference to the underlying netlist
+    /// A reference to the underlying netlist
     _netlist: &'a Netlist<I>,
-    // Maps a net to its logic level as a DAG
+    /// Maps a net to its logic level as a DAG
     comb_depth: HashMap<NetRef<I>, usize>,
     /// The maximum depth of the circuit
     max_depth: usize,

src/lib.rs

@@ -7,6 +7,8 @@
 An experimental library for representing circuit netlists for EDA tool development.
 Take a look at some [examples](https://github.com/matth2k/safety-net/tree/main/examples) and the [documentation](https://matth2k.github.io/safety-net/).
 
+The most important API is the [Netlist](https://matth2k.github.io/safety-net/safety_net/netlist/struct.Netlist.html) struct.
+
 */
 #![doc = "## Simple Example\n```"]
 #![doc = include_str!("../examples/simple.rs")]

src/netlist.rs

@@ -1271,7 +1271,6 @@ where
     }
 
     /// Set an added object as a top-level output.
-    /// Panics if `net`` is a multi-output node.
     pub fn expose_net_with_name(&self, net: DrivenNet<I>, name: Identifier) -> DrivenNet<I> {
         let mut outputs = self.outputs.borrow_mut();
         outputs.insert(net.get_operand(), net.as_net().with_name(name));