Skip to content

Commit 2bb458e

Browse files
authored
More consistent wording in our documentation (#385)
1 parent 92e0214 commit 2bb458e

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

core/common/src/Buffer.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ public class Buffer : Source, Sink {
6969
*/
7070
@InternalIoApi
7171
override val buffer: Buffer get() = this
72+
7273
override fun exhausted(): Boolean = size == 0L
7374

7475
override fun require(byteCount: Long) {
@@ -179,7 +180,7 @@ public class Buffer : Source, Sink {
179180
override fun flush(): Unit = Unit
180181

181182
/**
182-
* Copy bytes from this buffer's subrange starting at [startIndex] and ending at [endIndex], to [out] buffer.
183+
* Copies bytes from this buffer's subrange starting at [startIndex] and ending at [endIndex], to [out] buffer.
183184
* This method does not consume data from the buffer.
184185
*
185186
* @param out the destination buffer to copy data into.

core/jvm/src/BuffersJvm.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import java.nio.ByteBuffer
3030
import java.nio.channels.ByteChannel
3131

3232
/**
33-
* Read and exhaust bytes from [input] into this buffer. Stops reading data on [input] exhaustion.
33+
* Reads and exhausts bytes from [input] into this buffer. Stops reading data on [input] exhaustion.
3434
*
3535
* @param input the stream to read data from.
3636
*
@@ -42,7 +42,7 @@ public fun Buffer.transferFrom(input: InputStream): Buffer {
4242
}
4343

4444
/**
45-
* Read [byteCount] bytes from [input] into this buffer. Throws an exception when [input] is
45+
* Reads [byteCount] bytes from [input] into this buffer. Throws an exception when [input] is
4646
* exhausted before reading [byteCount] bytes.
4747
*
4848
* @param input the stream to read data from.
@@ -107,7 +107,7 @@ public fun Buffer.readTo(out: OutputStream, byteCount: Long = size) {
107107
}
108108

109109
/**
110-
* Copy bytes from this buffer's subrange, starting at [startIndex] and ending at [endIndex], to [out]. This method
110+
* Copies bytes from this buffer's subrange, starting at [startIndex] and ending at [endIndex], to [out]. This method
111111
* does not consume data from the buffer.
112112
*
113113
* @param out the destination to copy data into.

core/jvm/src/RawSink.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
package kotlinx.io
2222

2323
import java.io.Flushable
24+
2425
public actual interface RawSink : AutoCloseable, Flushable {
2526
public actual fun write(source: Buffer, byteCount: Long)
2627

0 commit comments

Comments
 (0)