godoc: Minor API doc edits. Timestamps are Unix milliseconds. #1111
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
|
This conflicts with #1109 because it edits the documentation of some constants. I think that PR should be merged first, then I will rebase and/or fix the merge conflicts here (whatever you prefer). |
milindl
reviewed
Feb 20, 2024
Comment on lines
+1014
to
+1015
| func NewOffsetSpecForTimestamp(timestamp_ms int64) OffsetSpec { | ||
| return OffsetSpec(timestamp_ms) |
There was a problem hiding this comment.
Suggested change
| func NewOffsetSpecForTimestamp(timestamp_ms int64) OffsetSpec { | |
| return OffsetSpec(timestamp_ms) | |
| func NewOffsetSpecForTimestamp(timestampMs int64) OffsetSpec { | |
| return OffsetSpec(timestampMs) |
(nit)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: