From 27262d4582c8c05045597e976451f27b6922db9c Mon Sep 17 00:00:00 2001
From: Andrew <andrew@digerati.co.nz>
Date: Wed, 20 Sep 2023 19:24:19 +1200
Subject: [PATCH] Add doc comments for from_path

---
 src/lib.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 8bec3651..c0c53e4a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -91,6 +91,9 @@ pub enum OutFile {
 }
 
 impl OutFile {
+    /// Construct a new `OutFile` with the given path.
+    ///
+    /// This is a convenience method for `OutFile::Path { path: Some(path), preserve_attrs: false }`.
     pub fn from_path(path: PathBuf) -> Self {
         OutFile::Path {
             path: Some(path),