[hotfix] Fix invalid comments in Committer #26578
Open
+2
−2
Conversation
This file contains hidden or 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
beliefer
commented
May 21, 2025
| @@ -38,7 +38,7 @@ | |||
| @Public | |||
| public interface Committer<CommT> extends AutoCloseable { | |||
| /** | |||
| * Commit the given list of {@link CommT}. | |||
| * Commit the given list of {@link CommitRequest}. | |||
There was a problem hiding this comment.
CommT is a generic parameter and we can't visit the link.
There was a problem hiding this comment.
nit: If you are changing this line, you could change List to Collection and all the references of list to collection.
beliefer
commented
May 21, 2025
| @@ -49,7 +49,7 @@ void commit(Collection<CommitRequest<CommT>> committables) | |||
| /** | |||
| * A request to commit a specific committable. | |||
| * | |||
| * @param <CommT> | |||
| * @param <CommT> The type of information needed to commit the staged data | |||
There was a problem hiding this comment.
Add the missing comments.
|
ping @AHeise @fapaul @pvary cc @1996fanrui @davidradl |
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.
What is the purpose of the change
This PR aims to fix invalid comments in
Committer.Brief change log
Fix invalid comments in
Committer.Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (no)Documentation