[TAR] Add notes about wrongField being unused into its doc comment

2026-06-23 14:56:41 +00:00 · 2018-07-14 20:41:05 +03:00
parent 2a2842ebc3
commit df347d850c
1 changed files with 5 additions and 1 deletions
@@ -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