Confusing subscriptions expire docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- go
- Domain
- cli, documentation
Research direction
Start with the pulsarctl subscriptions expire help text and the documentation covering its -t and -a flags. Clarify that -t expires one matching message unless -a is supplied, while -a expires all messages, then verify the wording matches the command behavior.
Written by the indexing model from the issue text.
Description
Hello, first of all I really like and enjoy using this tool 🙂
Some time ago I was trying to expire a couple of messaged from pulsar using pulsarctl subscriptions expire. I checked the docs:
ExpireMessages flags:
-t, --expire-time int Expire messages older than time in seconds
-a, --all Expire all messages
So I executed pulsarctl subscriptions expire -t 5 ... and expected that all messages older than 5 second will be expired, but after some poking around I realised that only one was.
I think that this is a little bit misleading - I though that -t will expire ALL messages older than int but it turned out that if -a is not specified it expire only a single message - my thinking was -a expired ALL messaged no matter what time they were published.
Do you think it would be worth reflecting that behaviour more clearly in the docs?
- Dominant language
- Go
- Stars
- 169
- Forks
- 68
- Avg merge
- 5m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from streamnative/pulsarctl
-
Difficulty 3/5 1-2 days Newbie friendliness 67/100
streamnative/pulsarctl#2070 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
streamnative/pulsarctl#1703 · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
streamnative/pulsarctl#1623 · 1 reaction ·
-
streamnative/pulsarctl#1604 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
streamnative/pulsarctl#1527 ·
All issues in streamnative/pulsarctl
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·