Commits on Dec 1, 2023

1. godoc: Minor API doc edits. Timestamps are Unix milliseconds. …

   This is a collection of minor API documentation edits I noticed while
   using ListOffsets. Notably: I had to look around to figure out that
   timestamps are Unix milliseconds.
   
   Detailed edits:
   
   * OffsetSpec: Reference defined constants and
     NewOffsetSpecForTimestamp. Attempt to clarify the constants using
     the wording from Java:
     https://kafka.apache.org/26/javadoc/org/apache/kafka/clients/admin/OffsetSpec.html
   * NewOffsetSpecForTimestamp: Rename parameter and clarify that
     timestamps are in Unix milliseconds.
   * ListOffsetsResultInfo: Timestamp is in Unix milliseconds.
   * ListOffsetsResult: Fix TopicPartiton typo. Clarify that this
     returns offsets for many TopicPartitions. Document how to create a
     valid OffsetSpec.
   * Consumer.OffsetsForTimes: Timestamps are Unix milliseconds.
   * Error: Document that Code() == ErrNoError is not an error.
   * Error.Error(): Separate two sentences so they are not incorrectly
     combined by godoc e.g. here:
     https://pkg.go.dev/github.com/confluentinc/confluent-kafka-go/v2@v2.3.0/kafka#Error.Error
   * ErrorCode: Document that ErrNoError is success.
   * offsets.go offsetsForTimes: Copy doc from Consumer.OffsetsForTimes.
   * Producer.OffsetsForTimes: Copy doc from Consumer.OffsetsForTimes.

   

   evanj committed Dec 1, 2023
   Configuration menu

   • View commit details
   • Copy full SHA for ccc7063
   • Browse repository at this point

   Copy the full SHA

   ccc7063 View commit details

   Browse the repository at this point in the history