Skip to content

Commit 4d1c403

Browse files
chore: small doc fix, missing period end of help (#20681)
1 parent 90dc2fc commit 4d1c403

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

docs/sources/shared/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1448,7 +1448,7 @@ dataobj:
14481448
[shaprefixsize: <int> | default = 2]
14491449

14501450
# The maximum amount of time to wait in seconds before flushing an object
1451-
# that is no longer receiving new writes
1451+
# that is no longer receiving new writes.
14521452
# CLI flag: -dataobj-consumer.idle-flush-timeout
14531453
[idle_flush_timeout: <duration> | default = 1h]
14541454

@@ -1457,7 +1457,7 @@ dataobj:
14571457
# CLI flag: -dataobj-consumer.max-builder-age
14581458
[max_builder_age: <duration> | default = 1h]
14591459

1460-
# The name of the Kafka topic
1460+
# The name of the Kafka topic.
14611461
# CLI flag: -dataobj-consumer.topic
14621462
[topic: <string> | default = ""]
14631463

pkg/dataobj/consumer/config.go

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,21 @@ func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
5050
cfg.LifecyclerConfig.RegisterFlagsWithPrefix(prefix, f, util_log.Logger)
5151
cfg.PartitionRingConfig.RegisterFlagsWithPrefix(prefix, f)
5252
cfg.UploaderConfig.RegisterFlagsWithPrefix(prefix, f)
53-
54-
f.StringVar(&cfg.Topic, prefix+"topic", "", "The name of the Kafka topic")
55-
f.DurationVar(&cfg.IdleFlushTimeout, prefix+"idle-flush-timeout", 60*60*time.Second, "The maximum amount of time to wait in seconds before flushing an object that is no longer receiving new writes")
56-
f.DurationVar(&cfg.MaxBuilderAge, prefix+"max-builder-age", time.Hour, "The maximum amount of time to accumulate data in a builder before flushing it. Defaults to 1 hour.")
53+
f.StringVar(
54+
&cfg.Topic,
55+
prefix+"topic",
56+
"",
57+
"The name of the Kafka topic.",
58+
)
59+
f.DurationVar(
60+
&cfg.IdleFlushTimeout,
61+
prefix+"idle-flush-timeout",
62+
time.Hour,
63+
"The maximum amount of time to wait in seconds before flushing an object that is no longer receiving new writes.",
64+
)
65+
f.DurationVar(&cfg.MaxBuilderAge,
66+
prefix+"max-builder-age",
67+
time.Hour,
68+
"The maximum amount of time to accumulate data in a builder before flushing it. Defaults to 1 hour.",
69+
)
5770
}

0 commit comments

Comments
 (0)