From bd6f626a53c1bc6807783139cfa59a4be5565da9 Mon Sep 17 00:00:00 2001
From: Wolfgang Faust <wolfgang42@users.noreply.github.com>
Date: Tue, 1 Jul 2025 11:49:32 -0700
Subject: [PATCH] header: update doc for Header.path

Add further documentation for #292
---
 src/header.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/header.rs b/src/header.rs
index 00e2eab0..b9730295 100644
--- a/src/header.rs
+++ b/src/header.rs
@@ -351,6 +351,8 @@ impl Header {
     ///
     /// Note that this function will convert any `\` characters to directory
     /// separators.
+    /// It is recommended to use `Entry.path()` instead of inspecting the `header`
+    /// directly to ensure that various archive formats are handled correctly.
     pub fn path(&self) -> io::Result<Cow<Path>> {
         bytes2path(self.path_bytes())
     }