Skip to content

[hotfix] Fix invalid comments in Committer #26578

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.

Sign up for GitHub

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

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

[hotfix] Fix invalid comments in Committer #26578

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions flink-core/src/main/java/org/apache/flink/api/connector/sink2/Committer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CommT is a generic parameter and we can't visit the link.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: If you are changing this line, you could change List to Collection and all the references of list to collection.

*
* @param committables A list of commit requests staged by the sink writer.
* @throws IOException for reasons that may yield a complete restart of the job.
Expand All @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the missing comments.

*/
@Public
interface CommitRequest<CommT> {
Expand Down