docs: add documentation for from_os() method

niclabs · Jan 21, 2025 · 107d636 · 107d636
1 parent 86e8e85
commit 107d636
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/async_resolver.rs b/src/async_resolver.rs
@@ -480,6 +480,15 @@ impl AsyncResolver {
         }
     }
 
+    /// Creates a new `AsyncResolver` based on the operating system of the current environment.
+    ///
+    /// # Panics
+    /// This function panics if the operating system is neither "linux" nor "windows".
+    ///
+    /// # Examples
+    /// ```
+    /// let resolver = AsyncResolver::from_os();
+    /// ```
     pub fn from_os() -> Self {
         let os = env::consts::OS;
         match os {