[Doc] Fix doc for the wrong default value of maxPendingChunkedMessage
#14144
Conversation
This file contains 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
Motivation There are inconsistencies between the code and the documentation regarding the default value of maxPendingChunkedMessage. Modification * Fix the wrong default value of `maxPendingChunkedMessage`. Use `10` as the default value. Signed-off-by: Zike Yang <zkyang@streamnative.io>
github-actions
bot
added
the
doc
Anonymitaet
reviewed
Feb 7, 2022
| @@ -687,7 +687,7 @@ | |||
| * the outstanding unchunked-messages by silently acking or asking broker to redeliver later by marking it unacked. | |||
| * This behavior can be controlled by configuration: @autoAckOldestChunkedMessageOnQueueFull | |||
| * | |||
| * @default 100 | |||
| * The default value is 10. | |||
There was a problem hiding this comment.
@default xx is the "fixed format" in Java API docs?
There was a problem hiding this comment.
@default is not the correct way to set the default value in the java doc. Using it will cause the default values to not show up in the java doc.
codelipenghui
approved these changes
Feb 7, 2022
|
/pulsarbot run-failure-checks |
Anonymitaet
approved these changes
Feb 8, 2022
gaoran10
approved these changes
Feb 8, 2022
Nicklee007
pushed a commit
to Nicklee007/pulsar
that referenced
this pull request
Apr 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
There are inconsistencies between the code and the documentation regarding the default value of maxPendingChunkedMessage.
Here is the discussion thread in the mailing list: https://lists.apache.org/thread/w4vfb5jd5xo9dndhrt7655pbhxn5xdvk
Modifications
maxPendingChunkedMessage. Use10as the default value.Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Documentation
doc