fixup: documentation for kill_state

mullvad · Jul 24, 2024 · a0cb0be · a0cb0be
1 parent c5cf6ef
commit a0cb0be
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -443,7 +443,9 @@ impl PfCtl {
         Ok(wrapped_states)
     }
 
-    /// Remove the specified state
+    /// Remove the specified state.
+    ///
+    /// All current states can be obtained via [get_states].
     pub fn kill_state(&mut self, state: &State) -> Result<()> {
         let mut pfioc_state_kill = unsafe { mem::zeroed::<ffi::pfvar::pfioc_state_kill>() };
         setup_pfioc_state_kill(state.as_raw(), &mut pfioc_state_kill);