[FLINK-23140][docs] Fix SourceFunction documentation link#28494
Open
Vamsi-klu wants to merge 2 commits into
Open
[FLINK-23140][docs] Fix SourceFunction documentation link#28494Vamsi-klu wants to merge 2 commits into
Vamsi-klu wants to merge 2 commits into
Conversation
Collaborator
spuru9
reviewed
Jun 20, 2026
3f5ed99 to
3cd52e4
Compare
Contributor
|
Can you update the description as needed by the PULL_REQUEST template as well. |
Author
|
Thanks, updated. I pushed the follow-up docs change so |
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
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 fixes the DataStream Data Sources documentation for the legacy source function APIs.
The current documentation mentions
SourceFunction,ParallelSourceFunction, andRichParallelSourceFunctiontogether when explaining how users can implement custom sources withStreamExecutionEnvironment.addSource(...).SourceFunctionwas updated to link to the current legacy source package, but the two related APIs in the same sentence were still left as plain code text.To keep the documentation consistent and easier to navigate, this PR links all three legacy source APIs to their current source files:
SourceFunctionParallelSourceFunctionRichParallelSourceFunctionThe same update is applied to both the English and Chinese DataStream documentation.
This closes FLINK-23140.
Brief change log
Verifying this change
This change is a documentation-only update without new test coverage.
Verified locally with:
test -f flink-runtime/src/main/java/org/apache/flink/streaming/api/functions/source/legacy/SourceFunction.javatest -f flink-runtime/src/main/java/org/apache/flink/streaming/api/functions/source/legacy/ParallelSourceFunction.javatest -f flink-runtime/src/main/java/org/apache/flink/streaming/api/functions/source/legacy/RichParallelSourceFunction.javagit diff --checkThe verification confirms that each linked target file exists and that the Markdown diff does not contain whitespace errors.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation
Was generative AI tooling used to co-author this PR?
Generated-by: OpenAI Codex