From df347d850c2280916211801d8be74daca4eafcf7 Mon Sep 17 00:00:00 2001
From: Timofey Solomko <tsolomko@gmail.com>
Date: Sat, 14 Jul 2018 20:41:05 +0300
Subject: [PATCH] [TAR] Add notes about wrongField being unused into its doc
 comment

---
 Sources/TAR/TarError.swift | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/Sources/TAR/TarError.swift b/Sources/TAR/TarError.swift
index e3345e33..60687c64 100644
--- a/Sources/TAR/TarError.swift
+++ b/Sources/TAR/TarError.swift
@@ -12,7 +12,11 @@ import Foundation
 public enum TarError: Error {
     /// Size of data is too small, even to contain only one header.
     case tooSmallFileIsPassed
-    /// Failed to process a TAR header's field.
+    /**
+     Failed to process a TAR header's field.
+
+     - Note: This error case is never thrown and will be removed in a future major update.
+     */
     case wrongField
     /// Computed checksum of a header doesn't match the value stored in container.
     case wrongHeaderChecksum