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-30636] [docs]: Typo fix; 'to to' -> 'to' #21648

Merged
merged 1 commit into from
Aug 3, 2023

Conversation

gunnarmorling
Copy link
Contributor

Just a fix of a surprisingly common typo in JavaDoc etc.

https://issues.apache.org/jira/browse/FLINK-30636

@gunnarmorling
Copy link
Contributor Author

// CC @rmetzger

Copy link
Contributor

@rmetzger rmetzger left a comment

Choose a reason for hiding this comment

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

+1 to merge once CI has passed

@flinkbot
Copy link
Collaborator

flinkbot commented Jan 11, 2023

CI report:

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

@rmetzger
Copy link
Contributor

The PR doesn't build:

[ERROR] Failed to execute goal com.diffplug.spotless:spotless-maven-plugin:2.27.1:check (spotless-check) on project flink-runtime: The following files had format violations:
[ERROR] src/main/java/org/apache/flink/runtime/io/network/api/TaskEventHandler.java
[ERROR] @@ -25,8 +25,7 @@
[ERROR] import·org.apache.flink.shaded.guava30.com.google.common.collect.Multimap;
[ERROR] 
[ERROR] /**
[ERROR] -·*·The·event·handler·manages·{@link·EventListener}·instances·and·allows·to·publish·events·to
[ERROR] -·*·them.
[ERROR] +·*·The·event·handler·manages·{@link·EventListener}·instances·and·allows·to·publish·events·to·them.
[ERROR] ·*/
[ERROR] public·class·TaskEventHandler·{
[ERROR] 
[ERROR] src/main/java/org/apache/flink/runtime/jobgraph/tasks/TaskOperatorEventGateway.java
[ERROR] @@ -30,8 +30,8 @@
[ERROR] import·java.util.concurrent.CompletableFuture;
[ERROR] 
[ERROR] /**
[ERROR] -·*·Gateway·to·send·an·{@link·OperatorEvent}·or·{@link·CoordinationRequest}·from·a·Task·to·the
[ERROR] -·*·{@link·OperatorCoordinator}·JobManager·side.
[ERROR] +·*·Gateway·to·send·an·{@link·OperatorEvent}·or·{@link·CoordinationRequest}·from·a·Task·to·the·{@link
[ERROR] +·*·OperatorCoordinator}·JobManager·side.
[ERROR] ·*
[ERROR] ·*·<p>This·is·the·first·step·in·the·chain·of·sending·Operator·Events·and·Requests·from·Operator·to
[ERROR] ·*·Coordinator.·Each·layer·adds·further·context,·so·that·the·inner·layers·do·not·need·to·know·about
[ERROR] src/test/java/org/apache/flink/runtime/io/network/partition/consumer/LocalInputChannelTest.java
[ERROR] @@ -401,8 +401,8 @@
[ERROR] ·····*·and·has·not·much·more·general·value.·If·it·becomes·obsolete·at·some·point·(future·greatness
[ERROR] ·····*·;)),·feel·free·to·remove·it.
[ERROR] ·····*
[ERROR] -·····*·<p>The·fix·in·the·end·was·to·not·acquire·the·channels·lock·when·releasing·it·and/or·not
[ERROR] -·····*·doing·any·input·gate·callbacks·while·holding·the·channel's·lock.·I·decided·to·do·both.
[ERROR] +·····*·<p>The·fix·in·the·end·was·to·not·acquire·the·channels·lock·when·releasing·it·and/or·not·doing
[ERROR] +·····*·any·input·gate·callbacks·while·holding·the·channel's·lock.·I·decided·to·do·both.
[ERROR] ·····*/
[ERROR] ····@Test
[ERROR] ····public·void·testConcurrentReleaseAndRetriggerPartitionRequest()·throws·Exception·{
[ERROR] Run 'mvn spotless:apply' to fix these violations.

@@ -186,7 +186,7 @@ public interface Environment {
TaskKvStateRegistry getTaskKvStateRegistry();

/**
* Confirms that the invokable has successfully completed all steps it needed to to for the
* Confirms that the invokable has successfully completed all steps it needed to for the
Copy link
Contributor

Choose a reason for hiding this comment

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

Zero to might even be better here!

Suggested change
* Confirms that the invokable has successfully completed all steps it needed to for the
* Confirms that the invokable has successfully completed all steps it needed for the

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hum, do you really think so? I'm not a native English speaker, but it seems right to me, judging by reverting the order of the sentence parts: "for the checkpoint, it completed to steps it needed to".

Copy link
Contributor

Choose a reason for hiding this comment

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

🤔 I'm originally anglophone, but not a great editor! We didn't learn much grammar, and trying to search for the correct grammar has led me down a rabbit hole of semi-modal verbs that probably isn't worth it :D While validating the PR this one stuck out to me, but a single to isn't wrong, so LGTM either way!

@gunnarmorling
Copy link
Contributor Author

Force-pushed an update to apply the formatter.

@gunnarmorling
Copy link
Contributor Author

@rmetzger, could we get this one merged?

@gunnarmorling
Copy link
Contributor Author

@rmetzger, gentle ping.

@rmetzger
Copy link
Contributor

rmetzger commented Aug 3, 2023

Ah, sorry for the oversight!

@rmetzger rmetzger merged commit b78cd3f into apache:master Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants