Skip to content

doc enhancements #1663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
roeschter wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc enhancements #1663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/consumer_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ func configureConsumerCommand(app commandHost) {
}
f.Flag("filter", "Filter Stream by subjects").PlaceHolder("SUBJECTS").StringsVar(&c.filterSubjects)
if !edit {
f.Flag("flow-control", "Enable Push consumer flow control").IsSetByUser(&c.fcSet).UnNegatableBoolVar(&c.fc)
f.Flag("flow-control", "Enable Push consumer flow control. Note: This is distinct from the 'flow_control` ack mode.").IsSetByUser(&c.fcSet).UnNegatableBoolVar(&c.fc)

@ripienaar ripienaar May 11, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we dont add notes like this in flag help, this would be the only example like this, these flags help is quick glance help and in the case of something so complex and so full of many 10s of flags the expectation is you're following documentation when using these esoteric options.

That's also why they aren't requested during the interactive question/answer phase.

Too long and verbose

f.Flag("heartbeat", "Enable idle Push consumer heartbeats (-1 disable)").StringVar(&c.idleHeartbeat)
}

Expand Down
4 changes: 2 additions & 2 deletions cli/stream_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,11 +222,11 @@ func configureStreamCommand(app commandHost) {
f.Flag("max-msgs", "Maximum amount of messages to keep").Default("0").Int64Var(&c.maxMsgLimit)
f.Flag("max-msgs-per-subject", "Maximum amount of messages to keep per subject").Default("0").Int64Var(&c.maxMsgPerSubjectLimit)
f.Flag("dupe-window", "Duration of the duplicate message tracking window").Default("").StringVar(&c.dupeWindow)
f.Flag("mirror", "Completely mirror another stream").StringVar(&c.mirror)
f.Flag("mirror", "Completely mirror another stream. Accepts mirror config as JSON. ").StringVar(&c.mirror)

@ripienaar ripienaar May 11, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This implies this all it accepts :) Just say like Completely mirror another stream, stream name or configuration JSON

if edit {
f.Flag("no-mirror", "Removes current mirror configuration").UnNegatableBoolVar(&c.noMirror)
}
f.Flag("source", "Source data from other streams, merging into this one").PlaceHolder("STREAM").StringsVar(&c.sources)
f.Flag("source", "Source data from other streams, merging into this one. Accepts source config as JSON.").PlaceHolder("STREAM").StringsVar(&c.sources)
f.Flag("allow-batch", "Allow atomic batch publishing").IsSetByUser(&c.allowAtomicBatchIsSet).BoolVar(&c.allowAtomicBatch)
f.Flag("allow-fast", "Allow fast batch publishing").IsSetByUser(&c.allowFastBatchIsSet).BoolVar(&c.allowFastBatch)
f.Flag("allow-counter", "Configures the stream as a distributed counter").IsSetByUser(&c.allowCounterIsSet).UnNegatableBoolVar(&c.allowCounter)
Expand Down
Loading