From 10905dc588bee47656a386297ce0307121bb2eb8 Mon Sep 17 00:00:00 2001 From: Timofey Solomko Date: Wed, 3 Nov 2021 20:41:48 +0300 Subject: [PATCH] [docs] Minor fixes to LZ4 documentation --- Sources/LZ4/LZ4+Compress.swift | 4 ++-- Sources/LZ4/LZ4.swift | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/Sources/LZ4/LZ4+Compress.swift b/Sources/LZ4/LZ4+Compress.swift index 00f699ec..556f83fc 100644 --- a/Sources/LZ4/LZ4+Compress.swift +++ b/Sources/LZ4/LZ4+Compress.swift @@ -11,8 +11,8 @@ extension LZ4: CompressionAlgorithm { /** Compresses `data` using LZ4 algortihm with default format and algorithm options. - The default options include: independent blocks, do not save checksums for compressed blocks, save checksum for the - uncompressed data, do not save the size of the uncompressed data, use 4 MB block size, no dictionary. + The default options include: independent blocks, do not save checksums for compressed blocks, save the checksum of + the uncompressed data, do not save the size of the uncompressed data, use 4 MB block size, no dictionary. */ public static func compress(data: Data) -> Data { return LZ4.compress(data: data, independentBlocks: true, blockChecksums: false, contentChecksum: true, diff --git a/Sources/LZ4/LZ4.swift b/Sources/LZ4/LZ4.swift index 45e5c518..99ae8349 100644 --- a/Sources/LZ4/LZ4.swift +++ b/Sources/LZ4/LZ4.swift @@ -6,6 +6,7 @@ import Foundation import BitByteData +/// Provides functions for compression and decompression for LZ4 algorithm. public enum LZ4: DecompressionAlgorithm { // Notes about implementation and performance.