Skip to content

[hotfix] Fix typos in docs, code comments, messages and config option descriptions - #29918

Open
arvindKandpal-ksolves wants to merge 1 commit into
apache:masterfrom
arvindKandpal-ksolves:FLINK-41479
Open

arvindKandpal-ksolves wants to merge 1 commit into
apache:masterfrom
arvindKandpal-ksolves:FLINK-41479

Conversation

@arvindKandpal-ksolves

@arvindKandpal-ksolves arvindKandpal-ksolves commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

What is the purpose of the change

Fix typos and duplicated words across the code base in one change, as requested in the review. This replaces the separate typo PRs #29913, #29914, #29915, #29916 and #29917.

Most changes are spelling fixes. Two of them also fix something that did not work:

  • The Hive dialect ALTER TABLE example used AFRER instead of AFTER, so the statement was not valid.
  • An entry in docs/data/sql_connectors.yml used the key catagory instead of category, which the sql_download_table shortcode reads.

Brief change log

  • Documentation: English and Chinese docs, docs/data, Hugo layouts and flink.js
  • Javadoc and code comments in flink-runtime, the table modules, core, connectors, filesystems, formats, state backends, streaming-java, cep, state-processing-api and python, plus pom comments and scripts
  • Comments and assertion/failure messages in tests and test utilities
  • User-facing exception messages, log messages and config option descriptions; execution_config_configuration.html is regenerated with the flink-docs generator
  • Javadoc lines that became longer were re-wrapped by Spotless

FailureEnricherUtils is not part of this change. Its log message is fixed together with a placeholder bug in #29919.

Verifying this change

This change is a trivial rework / code cleanup without any test coverage. There is no behavior change, and no test asserts on the changed messages.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? not applicable

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

Generated-by: Claude Code (Claude Opus 5.5)

@arvindKandpal-ksolves

Copy link
Copy Markdown
Contributor Author

Hi @1996fanrui @MartijnVisser @snuyanzin, could you please take a look at this PR when you have time? Thanks!

@arvindKandpal-ksolves arvindKandpal-ksolves changed the title [FLINK-41479] Fix typos in user-facing exception messages and config … [FLINK-41479][runtime][table] Fix typos in user-facing exception messages and config option descriptions Nov 12, 2026
@flinkbot

flinkbot commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@arvindKandpal-ksolves

Copy link
Copy Markdown
Contributor Author

Hi @snuyanzin @1996fanrui @MartijnVisser @RocMarshal, CI is green. Could one of you please take a look at this PR when you have time, and assign FLINK-41479 to me? Thanks!

@RocMarshal

Copy link
Copy Markdown
Contributor

Hi, @arvindKandpal-ksolves

Would you mind squashing the typo-fix patches into one?

@snuyanzin

Copy link
Copy Markdown
Contributor

I would also vote then to create ports to other branches (no special need to have them in current release however it will then help to avoid conflicts while further ports)

@arvindKandpal-ksolves arvindKandpal-ksolves changed the title [FLINK-41479][runtime][table] Fix typos in user-facing exception messages and config option descriptions [FLINK-41479] Fix typos in docs, code comments, messages and config option descriptions Nov 18, 2026
@arvindKandpal-ksolves

Copy link
Copy Markdown
Contributor Author

Thanks @RocMarshal @snuyanzin! Squashed all typo fixes into this PR as one commit and closed the other typo PRs. I'd keep this for master only for now. Happy to open ports later if needed.

@MartijnVisser MartijnVisser left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Like I mentioned on the Jira, let's not open Jira tickets for typo fixes. On backports: this applies cleanly to release-2.4, while 2.3, 2.2 and 1.20 conflict in 5, 13 and 52 files, so I think only a 2.4 port is worth it.

- [`execution.batch.adaptive.auto-parallelism.max-parallelism`]({{< ref "docs/deployment/config" >}}#execution-batch-adaptive-auto-parallelism-max-parallelism): The upper bound of allowed parallelism to set adaptively. The default parallelism set via [`parallelism.default`]({{< ref "docs/deployment/config" >}}) or `StreamExecutionEnvironment#setParallelism()` will be used as upper bound of allowed parallelism if this configuration is not configured.
- [`execution.batch.adaptive.auto-parallelism.avg-data-volume-per-task`]({{< ref "docs/deployment/config" >}}#execution-batch-adaptive-auto-parallelism-avg-data-volume-per-ta): The average size of data volume to expect each task instance to process. Note that when data skew occurs, or the decided parallelism reaches the max parallelism (due to too much data), the data actually processed by some tasks may far exceed this value.
- [`execution.batch.adaptive.auto-parallelism.default-source-parallelism`]({{< ref "docs/deployment/config" >}}#execution-batch-adaptive-auto-parallelism-default-source-paralle): The default parallelism of data source or the upper bound of source parallelism to set adaptively. The upper bound of allowed parallelism set via [`execution.batch.adaptive.auto-parallelism.max-parallelism`]({{< ref "docs/deployment/config" >}}#execution-batch-adaptive-auto-parallelism-max-parallelism) will be used if this configuration is not configured. If the upper bound of allowed parallelism is also not configured, the default parallelism set via [`parallelism.default`]({{< ref "docs/deployment/config" >}}) or `StreamExecutionEnvironment#setParallelism()` will be used instead.
- [`execution.batch.adaptive.auto-parallelism.default-source-parallelism`]({{< ref "docs/deployment/config" >}}#execution-batch-adaptive-auto-parallelism-default-source-parallelism): The default parallelism of data source or the upper bound of source parallelism to set adaptively. The upper bound of allowed parallelism set via [`execution.batch.adaptive.auto-parallelism.max-parallelism`]({{< ref "docs/deployment/config" >}}#execution-batch-adaptive-auto-parallelism-max-parallelism) will be used if this configuration is not configured. If the upper bound of allowed parallelism is also not configured, the default parallelism set via [`parallelism.default`]({{< ref "docs/deployment/config" >}}) or `StreamExecutionEnvironment#setParallelism()` will be used instead.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This link worked before. AnchorJS cuts generated ids at 64 characters, so the anchor really is ...-source-paralle, same as ...-avg-data-volume-per-ta a few lines up. Could you revert these two links here and the two in content.zh?

… descriptions

Fix misspellings and duplicated words across the code base:
- Documentation (English and Chinese docs, docs data files, Hugo
  layouts). This also fixes an invalid "AFRER" in a Hive dialect SQL
  example and a misspelled "catagory" key in sql_connectors.yml.
- Javadoc and code comments in flink-runtime, the table modules, core,
  connectors, formats, state backends, streaming and python.
- Comments and assertion messages in tests and test utilities.
- User-facing exception messages, log messages and config option
  descriptions. The generated config docs are regenerated.

There is no behavior change, and no test asserts on the changed
messages.

Generated-by: Claude Code (Claude Opus 5.5)
@arvindKandpal-ksolves arvindKandpal-ksolves changed the title [FLINK-41479] Fix typos in docs, code comments, messages and config option descriptions [hotfix] Fix typos in docs, code comments, messages and config option descriptions Nov 20, 2026
@arvindKandpal-ksolves

Copy link
Copy Markdown
Contributor Author

Thanks @MartijnVisser! You are right about the anchors. I checked that AnchorJS cuts the ids at 64 characters, and reverted the 4 links. I also renamed the PR and the commit to [hotfix]. The port to release-2.4 is in #30041.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants