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

[FLINK-19409][Documentation] remove unrelated comment for getValue in ListView #13487

Conversation

Myracle
Copy link
Contributor

@Myracle Myracle commented Sep 27, 2020

What is the purpose of the change

In class ListView, the comment for method getValue has unrelated code 'accumulator.list.add(id);'. Users and developers may be confused with the comment. It should be removed.

Brief change log

  • Remove the unrelated code comment and rewrite the example.

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

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/Mesos, 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 / docs / JavaDocs / not documented)

@flinkbot
Copy link
Collaborator

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 9cbc32f (Sun Sep 27 02:31:28 UTC 2020)

Warnings:

  • No documentation files were touched! Remember to keep the Flink docs up to date!

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented Sep 27, 2020

CI report:

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

@Myracle
Copy link
Contributor Author

Myracle commented Sep 27, 2020

@wuchong Please review the code. Thank you.

Copy link
Member

@wuchong wuchong left a comment

Choose a reason for hiding this comment

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

I think the current example code is still hard to understand. Could you make it to be a more practical example? The example in MapView is nice, you can take that as an example.

@Myracle Myracle force-pushed the FLINK-19409-remove-unrelated-comment-for-getValue-in-ListView branch from 9cbc32f to f756ebd Compare September 29, 2020 04:38
@Myracle
Copy link
Contributor Author

Myracle commented Sep 29, 2020

@wuchong It is a valuable suggestion and I have change the example. Have a code review?

@Myracle Myracle force-pushed the FLINK-19409-remove-unrelated-comment-for-getValue-in-ListView branch from f756ebd to 86351d8 Compare October 10, 2020 10:16
@wuchong wuchong merged commit adedf07 into apache:master Oct 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants