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

[fix][client] Fix the javadoc for startMessageIdInclusive #23508

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

Conversation

summeriiii
Copy link
Contributor

Fixes #23498

Motivation

/**
   * 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

Modifications

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

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Matching PR in forked repository

PR in forked repository:

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Oct 23, 2024
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 this pull request may close these issues.

[Doc] the javadoc of ReaderBuilder#startMessageIdInclusive and ConsumerBuilder#startMessageIdInclusive
1 participant