doc enhancements#1663
Open
roeschter wants to merge 1 commit into
Open
Conversation
ripienaar
requested changes
May 11, 2026
| 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) |
Collaborator
There was a problem hiding this comment.
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("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) |
Collaborator
There was a problem hiding this comment.
This implies this all it accepts :) Just say like Completely mirror another stream, stream name or configuration JSON
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Clarification on documentation.