Repository navigation
[BP-2.4][FLINK-41407][docs] Fix code examples in the documentation - #29896
Merged
MartijnVisser merged 1 commit intoNov 12, 2026
Merged
Conversation
…he#29837) Many code examples in the docs did not compile, parse or run on master, used deprecated APIs or removed config keys, or printed results Flink does not return. - Java: fix examples that do not compile and replace deprecated APIs; call cache() on a transformation result (FLINK-30097) - Scala: remove the tabs that use the DataStream API removed in 2.0 - SQL: fix examples that fail to parse or validate, and terminate multi-statement examples - Python: fix examples that do not run - Config: fix examples Flink rejects or ignores, deprecated keys and option links, and describe batch shuffle as it works since 2.0 - SQL Gateway: name sql-gateway.session.plan-cache.enabled in the plan cache option descriptions - Fix printed results that differ from real output, and render the Docker build commands as a code block The same changes go into docs/content.zh, translated where the section is already in Chinese. Generated-by: Claude Code (Claude Opus 5.5) (cherry picked from commit 50334ae)
Collaborator
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
Unchanged backport of #29837.
Brief change log
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Ran the changed examples from the English and Chinese pages against release-2.4 snapshot jars, with the same results as on master. The Hugo build passes, with no new dead anchors.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): no (only the descriptions of two@PublicEvolvingSQL Gateway options change)Documentation
Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Claude Opus 5.5)