Skip to content
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.

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

[hotfix] [docs] Update table environment variable name in common.md #25669

Open
wants to merge 1 commit into
base: release-1.20
Choose a base branch
from

Conversation

Huachao
Copy link
Contributor

@Huachao Huachao commented Nov 20, 2024

What is the purpose of the change

Fix enviroment variable name inconsistence in code snippet.

Brief change log

  • Change tableEnv to tEnv for both Java and Scala

Verifying this change

Since the changes affect the doc examples and there are no tests. I copied the snippets and verified (compiled) them locally.

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

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

Documentation

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

@flinkbot
Copy link
Collaborator

flinkbot commented Nov 20, 2024

CI report:

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

@@ -387,19 +387,19 @@ Table table = ...;

// register the view named 'exampleView' in the catalog named 'custom_catalog'
// in the database named 'custom_database'
tableEnv.createTemporaryView("exampleView", table);

Choose a reason for hiding this comment

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

I notice that the English version uses tableEnv as the variable name. I suggest changing them both to be consistent in this PR. Changing the variable definition to tableEnv here - would seem to be the minimal change - unless there is a compelling reason to use tEnv.

@davidradl
Copy link

Reviewed by Chi on 21/11/24. Asked submitter questions

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.

3 participants