[GitHub] [kafka] ableegoldman commented on a diff in pull request #12169: MINOR: improve description of `commit.interval.ms` config

[GitBox <gi...@apache.org>]

ableegoldman commented on code in PR #12169:
URL: https://github.com/apache/kafka/pull/12169#discussion_r879960393


##########
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:
##########
@@ -452,7 +452,9 @@ public class StreamsConfig extends AbstractConfig {
     /** {@code commit.interval.ms} */
     @SuppressWarnings("WeakerAccess")
     public static final String COMMIT_INTERVAL_MS_CONFIG = "commit.interval.ms";
-    private static final String COMMIT_INTERVAL_MS_DOC = "The frequency in milliseconds with which to save the position of the processor." +
+    private static final String COMMIT_INTERVAL_MS_DOC = "The frequency in milliseconds with which to commit processing progress." +
+        " For at-least-once processing, committing means to save the position (ie, offsets) of the processor." +
+        " For exactly-once processing, it means to commit the transaction which includes to save the position." +

Review Comment:
   +1 to what Bruno said -- the current wording, `"to save the position"` is more like an implementation detail (sort of) but we should be explaining this in terms of what it actually affects for the user/what's visible to them, which is as Bruno describes to make the data actually readable



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org