Skip to content

Commit 26a5386

Browse files
committed
Update comments text
1 parent c7d53b8 commit 26a5386

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Sources/BinaryKit/BinaryKit.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public struct Binary {
5858

5959
// MARK: - Bit
6060

61-
/// Returns the binary value `0` or `1` of the given position.
61+
/// Returns an `UInt8` with the value of 0 or 1 of the given position.
6262
public func getBit(index: Int) throws -> UInt8 {
6363
guard (0..<(bytesStore.count)).contains(index / byteSize) else {
6464
throw BinError.outOfBounds
@@ -78,8 +78,8 @@ public struct Binary {
7878
}
7979
}
8080

81-
/// Returns the binary value `0` or `1` of the given position and
82-
/// increments the reading cursor by one bit.
81+
/// Returns an `UInt8` with the value of 0 or 1 of the given
82+
/// position and increments the reading cursor by one bit.
8383
public mutating func readBit() throws -> UInt8 {
8484
defer { bitCursor = incrementedCursorBy(bits: 1) }
8585
return try getBit(index: bitCursor)

0 commit comments

Comments
 (0)