Update comments, swiftlint autocorrect and rename some tests

Author: tsolomko

Sources/LsbBitWriter.swift

@@ -54,14 +54,15 @@ public final class LsbBitWriter: BitWriter {
             mask <<= 1
         }
     }
-    
+
     /**
      Writes `number`, using and advancing by `bitsCount` BIT positions.
 
      - Note: If `bitsCount` is smaller than the actual amount of `number`'s bits than the `number` will be truncated to
      fit into `bitsCount` amount of bits.
      - Note: Bits of `number` are processed using the same bit-numbering scheme as of the writer (i.e. "LSB 0").
-     - Note: This method is specifically useful when needing to write a UInt64 which can overflow and crash if converting to an Int when using the regular `write` method
+     - Note: This method is especially useful when it is necessary to write an unsigned number which overflows and,
+     thus, crashes when converting to an `Int` if `write(number:bitsCount:)` method is used.
      */
     public func write(unsignedNumber: UInt, bitsCount: Int) {
         var mask: UInt = 1
@@ -70,7 +71,7 @@ public final class LsbBitWriter: BitWriter {
             mask <<= 1
         }
     }
-    
+
     /**
      Writes `byte`, advancing by one BYTE position.
 

Sources/MsbBitWriter.swift

@@ -54,14 +54,15 @@ public final class MsbBitWriter: BitWriter {
             mask >>= 1
         }
     }
-    
+
     /**
      Writes `number`, using and advancing by `bitsCount` BIT positions.
 
      - Note: If `bitsCount` is smaller than the actual amount of `number`'s bits than the `number` will be truncated to
      fit into `bitsCount` amount of bits.
      - Note: Bits of `number` are processed using the same bit-numbering scheme as of the writer (i.e. "MSB 0").
-     - Note: This method is specifically useful when needing to write a UInt64 which can overflow and crash if converting to an Int when using the regular `write` method
+     - Note: This method is especially useful when it is necessary to write an unsigned number which overflows and,
+     thus, crashes when converting to an `Int` if `write(number:bitsCount:)` method is used.
      */
     public func write(unsignedNumber: UInt, bitsCount: Int) {
         var mask: UInt = 1 << (UInt(truncatingIfNeeded: bitsCount) - 1)

Tests/BitByteDataTests/LsbBitWriterTests.swift

@@ -41,6 +41,14 @@ class LsbBitWriterTests: XCTestCase {
         XCTAssertEqual(bitWriter.data, Data(bytes: [255, 62, 3]))
     }
 
+    func testWriteUnsignedNumber() {
+        let bitWriter = LsbBitWriter()
+        bitWriter.write(unsignedNumber: UInt(UInt64.max), bitsCount: UInt64.bitWidth)
+
+        let byteReader = ByteReader(data: bitWriter.data)
+        XCTAssertEqual(byteReader.uint64(), UInt64.max)
+    }
+
     func testAppendByte() {
         let bitWriter = LsbBitWriter()
 
@@ -78,13 +86,5 @@ class LsbBitWriterTests: XCTestCase {
         let bitReader = LsbBitReader(data: bitWriter.data)
         XCTAssertEqual(bitReader.int(fromBits: 14), 14582)
     }
-    
-    func testUInt64() {
-        let bitWriter = LsbBitWriter()
-        bitWriter.write(unsignedNumber: UInt(UInt64.max), bitsCount: UInt64.bitWidth)
-        
-        let byteReader = ByteReader.init(data: bitWriter.data)
-        XCTAssertEqual(byteReader.uint64(), UInt64.max)
-    }
 
 }

Tests/BitByteDataTests/MsbBitWriterTests.swift

@@ -44,6 +44,14 @@ class MsbBitWriterTests: XCTestCase {
         XCTAssertEqual(bitWriter.data, Data(bytes: [255, 217, 192]))
     }
 
+    func testWriteUnsignedNumber() {
+        let bitWriter = MsbBitWriter()
+        bitWriter.write(unsignedNumber: UInt(UInt64.max), bitsCount: UInt64.bitWidth)
+
+        let byteReader = ByteReader(data: bitWriter.data)
+        XCTAssertEqual(byteReader.uint64(), UInt64.max)
+    }
+
     func testAppendByte() {
         let bitWriter = LsbBitWriter()
 
@@ -81,13 +89,5 @@ class MsbBitWriterTests: XCTestCase {
         let bitReader = MsbBitReader(data: bitWriter.data)
         XCTAssertEqual(bitReader.int(fromBits: 14), 14582)
     }
-    
-    func testUInt64() {
-        let bitWriter = MsbBitWriter()
-        bitWriter.write(unsignedNumber: UInt(UInt64.max), bitsCount: UInt64.bitWidth)
-        
-        let byteReader = ByteReader.init(data: bitWriter.data)
-        XCTAssertEqual(byteReader.uint64(), UInt64.max)
-    }
 
 }