Skip to content

Commit

Permalink
doc: add missing sentences in a function comment
Browse files Browse the repository at this point in the history
Refs: IBM#2374
  • Loading branch information
hsweif authored and dnwe committed Jul 27, 2023
1 parent 849c8b1 commit 6ff49a0
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions mocks/consumer.go
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,10 @@ func (c *Consumer) SetTopicMetadata(metadata map[string][]int32) {
// The registered PartitionConsumer will be returned, so you can set expectations
// on it using method chaining. Once a topic/partition is registered, you are
// expected to start consuming it using ConsumePartition. If that doesn't happen,
// an error will be written to the error reporter once the mock consumer is closed. It will
// also expect that the
// an error will be written to the error reporter once the mock consumer is closed. It also expects
// that the message and error channels be written with YieldMessage and YieldError accordingly,
// and be fully consumed once the mock consumer is closed if ExpectMessagesDrainedOnClose or
// ExpectErrorsDrainedOnClose have been called.
func (c *Consumer) ExpectConsumePartition(topic string, partition int32, offset int64) *PartitionConsumer {
c.l.Lock()
defer c.l.Unlock()
Expand Down

0 comments on commit 6ff49a0

Please sign in to comment.