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] the javadoc of ReaderBuilder#startMessageIdInclusive and ConsumerBuilder#startMessageIdInclusive #23498

Open
2 tasks done
summeriiii opened this issue Oct 22, 2024 · 0 comments · May be fixed by #23508
Open
2 tasks done
Labels
doc-required Your PR changes impact docs and you will update later.

Comments

@summeriiii
Copy link
Contributor

summeriiii commented Oct 22, 2024

Search before asking

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

 /**
    * Set the reader to include the given position of {@link ReaderBuilder#startMessageId(MessageId)}
    *
    * <p>This configuration option also applies for any cursor reset operation like {@link Reader#seek(MessageId)}.
    *
    * @return the reader builder instance
    */
   ReaderBuilder<T> startMessageIdInclusive();
    /**
     * Sets the consumer to include the given position of any reset operation like {@link Consumer#seek(long)} or
     * {@link Consumer#seek(MessageId)}}.
     *
     * @return the consumer builder instance
     */
    ConsumerBuilder<T> startMessageIdInclusive();

The ReaderBuilder#startMessageIdInclusive and ConsumerBuilder#startMessageIdInclusive method comments said Sets the consumer to include the given position of any reset operation like {@link Consumer#seek(long)} or * {@link Consumer#seek(MessageId)}}..
But I found that Consumer#seek(long) will contain the firstMessageId regardless of whether startMessageIdInclusive is present or not, the Consumer#seek(long) and startMessageIdInclusive have no relation

What is your suggestion?

remove the Consumer#seek(long) in comment of ReaderBuilder#startMessageIdInclusive and ConsumerBuilder#startMessageIdInclusive

Any reference?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!
@summeriiii summeriiii added the doc-required Your PR changes impact docs and you will update later. label Oct 22, 2024
@summeriiii summeriiii linked a pull request Oct 23, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required Your PR changes impact docs and you will update later.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant