From 309a07ed158e2c093bba2763f4eaedfb4a650ebd Mon Sep 17 00:00:00 2001 From: Timofey Solomko Date: Sat, 17 Mar 2018 15:37:41 +0300 Subject: [PATCH] [docs] Slightly simplify notes about entries order of container functions --- Sources/7-Zip/7zContainer.swift | 16 ++++++++-------- Sources/TAR/TarContainer.swift | 12 ++++++------ Sources/ZIP/ZipContainer.swift | 12 ++++++------ 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Sources/7-Zip/7zContainer.swift b/Sources/7-Zip/7zContainer.swift index b77515a2..d84b2309 100644 --- a/Sources/7-Zip/7zContainer.swift +++ b/Sources/7-Zip/7zContainer.swift @@ -14,9 +14,9 @@ public class SevenZipContainer: Container { /** Processes 7-Zip container and returns an array of `SevenZipEntry` with information and data for all entries. - - Important: The order of entries is defined by 7-Zip container and, particularly, - by the creator of a given 7-Zip container. It is likely that directories will be encountered earlier - than files stored in those directories, but one SHOULD NOT rely on any particular order. + - Important: The order of entries is defined by 7-Zip container and, particularly, by the creator of a given 7-Zip + container. It is likely that directories will be encountered earlier than files stored in those directories, but no + particular order is guaranteed. - Parameter container: 7-Zip container's data. @@ -165,12 +165,12 @@ public class SevenZipContainer: Container { } /** - Processes 7-Zip container and returns an array of `SevenZipEntryInfo` - with information about entries in this container. + Processes 7-Zip container and returns an array of `SevenZipEntryInfo` with information about entries in this + container. - - Important: The order of entries is defined by 7-Zip container and, particularly, - by the creator of a given 7-Zip container. It is likely that directories will be encountered earlier - than files stored in those directories, but one SHOULD NOT rely on any particular order. + - Important: The order of entries is defined by 7-Zip container and, particularly, by the creator of a given 7-Zip + container. It is likely that directories will be encountered earlier than files stored in those directories, but no + particular order is guaranteed. - Parameter container: 7-Zip container's data. diff --git a/Sources/TAR/TarContainer.swift b/Sources/TAR/TarContainer.swift index a1e15d89..ebf3ad8b 100644 --- a/Sources/TAR/TarContainer.swift +++ b/Sources/TAR/TarContainer.swift @@ -12,9 +12,9 @@ public class TarContainer: Container { /** Processes TAR container and returns an array of `TarEntry` with information and data for all entries. - - Important: The order of entries is defined by TAR container and, particularly, - by the creator of a given TAR container. It is likely that directories will be encountered earlier - than files stored in those directories, but one SHOULD NOT rely on any particular order. + - Important: The order of entries is defined by TAR container and, particularly, by the creator of a given TAR + container. It is likely that directories will be encountered earlier than files stored in those directories, but no + particular order is guaranteed. - Parameter container: TAR container's data. @@ -43,9 +43,9 @@ public class TarContainer: Container { /** Processes TAR container and returns an array of `TarEntryInfo` with information about entries in this container. - - Important: The order of entries is defined by TAR container and, particularly, - by the creator of a given TAR container. It is likely that directories will be encountered earlier - than files stored in those directories, but one SHOULD NOT rely on any particular order. + - Important: The order of entries is defined by TAR container and, particularly, by the creator of a given TAR + container. It is likely that directories will be encountered earlier than files stored in those directories, but no + particular order is guaranteed. - Parameter container: TAR container's data. diff --git a/Sources/ZIP/ZipContainer.swift b/Sources/ZIP/ZipContainer.swift index 8b25656d..d2b2ed33 100644 --- a/Sources/ZIP/ZipContainer.swift +++ b/Sources/ZIP/ZipContainer.swift @@ -12,9 +12,9 @@ public class ZipContainer: Container { /** Processes ZIP container and returns an array of `ZipEntry` with information and data for all entries. - - Important: The order of entries is defined by ZIP container and, particularly, - by the creator of a given ZIP container. It is likely that directories will be encountered earlier - than files stored in those directories, but one SHOULD NOT rely on any particular order. + - Important: The order of entries is defined by ZIP container and, particularly, by the creator of a given ZIP + container. It is likely that directories will be encountered earlier than files stored in those directories, but no + particular order is guaranteed. - Parameter container: ZIP container's data. @@ -115,9 +115,9 @@ public class ZipContainer: Container { /** Processes ZIP container and returns an array of `ZipEntryInfo` with information about entries in this container. - - Important: The order of entries is defined by ZIP container and, particularly, - by the creator of a given ZIP container. It is likely that directories will be encountered earlier - than files stored in those directories, but one SHOULD NOT rely on any particular order. + - Important: The order of entries is defined by ZIP container and, particularly, by the creator of a given ZIP + container. It is likely that directories will be encountered earlier than files stored in those directories, but no + particular order is guaranteed. - Parameter container: ZIP container's data.