Skip to content
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.

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

[Doc] Priority level documentation incomplete and potentially misleading #21922

Closed
2 tasks done
mwhipple opened this issue Jan 18, 2024 · 0 comments · Fixed by #21980
Closed
2 tasks done

[Doc] Priority level documentation incomplete and potentially misleading #21922

mwhipple opened this issue Jan 18, 2024 · 0 comments · Fixed by #21980
Assignees
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Comments

@mwhipple
Copy link
Contributor

Search before asking

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

The reference documentation for priority level for the Java SDK at least (https://github.com/apache/pulsar/blob/master/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java#L536) omits prerequisites around topic partitioning for failover subscriptions

What is your suggestion?

Qualify that at least the Failover subscription behavior only applies to partitioned topics (i.e.
<p><b>Failover subscription <em>for partitioned topics</em></b></p>)

Any reference?

Are you willing to submit a PR?

  • I'm willing to submit a PR!
@mwhipple mwhipple added the doc-required Your PR changes impact docs and you will update later. label Jan 18, 2024
@Technoboy- Technoboy- added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. and removed doc-required Your PR changes impact docs and you will update later. labels Jan 18, 2024
mwhipple added a commit to mwhipple/pulsar that referenced this issue Jan 27, 2024
mwhipple added a commit to mwhipple/pulsar that referenced this issue Jan 27, 2024
Fixes: apache#21922

This change is a trivial rework / code cleanup without any test coverage.

<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->

*If the box was checked, please highlight the changes*

- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] The metrics
- [ ] Anything that affects deployment

<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->

- [X] `doc` <!-- Your PR contains doc changes. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
mwhipple added a commit to mwhipple/pulsar that referenced this issue Jan 27, 2024
Fixes: apache#21922

This change is a trivial rework / code cleanup without any test coverage.

<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->

*If the box was checked, please highlight the changes*

- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] The metrics
- [ ] Anything that affects deployment

<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->

- [X] `doc` <!-- Your PR contains doc changes. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
mwhipple added a commit to mwhipple/pulsar that referenced this issue Jan 27, 2024
Fixes: apache#21922

### Motivation

Clarify when priorityLevel is active for failover subscriptions.

### Modifications

Update javaDoc comment to specify paritioned topics and indicate insignificance for non-partitioned.

### Verifying this change

- [X] Make sure that the change passes the CI checks.

This change is a trivial rework / code cleanup without any test coverage.

### Does this pull request potentially affect one of the following parts:

*If the box was checked, please highlight the changes*

- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] The metrics
- [ ] Anything that affects deployment

### Documentation

- [X] `doc` <!-- Your PR contains doc changes. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->

### Matching PR in forked repository

PR in forked repository: N/A
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants