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