Skip to content

MINOR: fix linking errors in javadoc#8198

Merged
kkonstantine merged 1 commit intoapache:trunkfrom
chia7712:fix_javadoc
Mar 22, 2020
Merged

MINOR: fix linking errors in javadoc#8198
kkonstantine merged 1 commit intoapache:trunkfrom
chia7712:fix_javadoc

Conversation

@chia7712
Copy link
Copy Markdown
Member

@chia7712 chia7712 commented Mar 1, 2020

It seems to me we should block PR for javadoc error since the doc error is too noisy to the build log.

The Javadoc error about inaccessible link is NOT included by this PR.

related to #8291

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

@chia7712 chia7712 force-pushed the fix_javadoc branch 2 times, most recently from 7dc3428 to 4c123bb Compare March 3, 2020 07:19
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

avoid importing ProducerRecord explicitly

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

avoid importing ConsumerRecords explicitly

soondenana pushed a commit to soondenana/kafka that referenced this pull request Mar 4, 2020
…pache#6678)

Minor fix of apache#8198 apache/kafka-site#210

Reviewers: John Roesler <john@confluent.io>, Bill Bejeck <bbejeck@gmail.com>
apovzner pushed a commit to apovzner/kafka that referenced this pull request Mar 5, 2020
…pache#6678)

Minor fix of apache#8198 apache/kafka-site#210

Reviewers: John Roesler <john@confluent.io>, Bill Bejeck <bbejeck@gmail.com>
brianbushree pushed a commit to brianbushree/kafka that referenced this pull request Mar 14, 2020
…pache#6678)

Minor fix of apache#8198 apache/kafka-site#210

Reviewers: John Roesler <john@confluent.io>, Bill Bejeck <bbejeck@gmail.com>
Copy link
Copy Markdown
Contributor

@kkonstantine kkonstantine left a comment

Choose a reason for hiding this comment

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

Thanks @chia7712
This looks pretty good overall. I've added suggestions in a few places that needed improvement.
Also, a few of the issues have been fixed in other PRs, so it'd be good to rebase.

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.

Suggested change
* Options for the {@link AdminClient#alterConsumerGroupOffsets(String, Map)} call.
* Options for the {@link AdminClient#alterConsumerGroupOffsets(String, Map, AlterConsumerGroupOffsetsOptions)} call.

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.

Suggested change
* Options for {@link Admin#electLeaders(ElectionType, Set, ElectLeadersOptions)} .
* Options for {@link Admin#electLeaders(ElectionType, Set, ElectLeadersOptions)}.

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.

Suggested change
import java.util.Collection;
import java.util.Collection;

Comment on lines 19 to 20
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.

Suggested change
import java.util.Map;
import java.util.Map;

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 has been fixed by: #8291
Please omit and rebase to get the latest changes.

Comment on lines 20 to 22
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.

Suggested change
import java.util.Arrays;
import java.util.Set;
import org.apache.kafka.common.annotation.InterfaceStability;
import org.apache.kafka.common.annotation.InterfaceStability;
import java.util.Arrays;
import java.util.Set;

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Is there a rule of imports layout? I observe the following layout in project.

import org.apache.kafka.common.KafkaFuture;
import org.apache.kafka.common.Node;
import org.apache.kafka.common.acl.AclOperation;
import org.apache.kafka.common.annotation.InterfaceStability;

import java.util.Collection;
import java.util.Set;
import java.util.Set;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.atomic.AtomicInteger;
import org.apache.kafka.clients.ApiVersions;
import org.apache.kafka.clients.producer.Callback;
import org.apache.kafka.common.utils.ProducerIdAndEpoch;
import org.apache.kafka.common.Cluster;

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 has been fixed by: #8291
Please omit and rebase to get the latest changes.

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 has been fixed by: #8291
Please omit and rebase to get the latest changes.

But see below on line 126 for a misformatting that needs to be fixed:
@{link commitRecord(SourceRecord)} needs to be {@link #commitRecord(SourceRecord)}

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 has been fixed by: #8314
Please omit and rebase to get the latest changes.

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 has been fixed by: #8314
Please omit and rebase to get the latest changes.

Same for the rest of the issues in this file probably

@chia7712
Copy link
Copy Markdown
Member Author

This looks pretty good overall. I've added suggestions in a few places that needed improvement.
Also, a few of the issues have been fixed in other PRs, so it'd be good to rebase.

@kkonstantine thanks for reviews!!!

@kkonstantine
Copy link
Copy Markdown
Contributor

Unfortunately, the tests
org.apache.kafka.streams.integration.StandbyTaskEOSIntegrationTest.surviveWithOneTaskAsStandby
and org.apache.kafka.streams.integration.StandbyTaskEOSIntegrationTest.surviveWithOneTaskAsStandby
failed dependably in both builders.

But since these were the only failures, and these tests are not related to the changes, I'll go ahead and merge this javadoc improvements to trunk.

@kkonstantine kkonstantine changed the title Minor: fix javadoc error MINOR: fix linking errors in javadoc Mar 22, 2020
@kkonstantine kkonstantine merged commit 4f69079 into apache:trunk Mar 22, 2020
@kkonstantine
Copy link
Copy Markdown
Contributor

Merged to trunk. Thanks for the fixes @chia7712 !

jjkoshy pushed a commit to jjkoshy/kafka that referenced this pull request Mar 27, 2020
…e non-existent method pipe (apache#6678)

TICKET =
LI_DESCRIPTION =
EXIT_CRITERIA = HASH [62617b9]
ORIGINAL_DESCRIPTION =

Minor fix of apache#8198 apache/kafka-site#210

Reviewers: John Roesler <john@confluent.io>, Bill Bejeck <bbejeck@gmail.com>
(cherry picked from commit 62617b9)
qinghui-xu pushed a commit to criteo-forks/kafka that referenced this pull request Apr 2, 2020
…pache#6678)

Minor fix of apache#8198 apache/kafka-site#210

Reviewers: John Roesler <john@confluent.io>, Bill Bejeck <bbejeck@gmail.com>
salewski pushed a commit to salewski/kafka that referenced this pull request May 4, 2020
…pache#6678)

Minor fix of apache#8198 apache/kafka-site#210

Reviewers: John Roesler <john@confluent.io>, Bill Bejeck <bbejeck@gmail.com>
gardnervickers pushed a commit to gardnervickers/kafka-1 that referenced this pull request Feb 4, 2021
* apache-github/2.3:
  MINOR: Update documentation for enabling optimizations (apache#7099)
  MINOR: Remove stale streams producer retry default docs. (apache#6844)
  KAFKA-8635; Skip client poll in Sender loop when no request is sent (apache#7085)
  KAFKA-8615: Change to track partition time breaks TimestampExtractor (apache#7054)
  KAFKA-8670; Fix exception for kafka-topics.sh --describe without --topic mentioned (apache#7094)
  KAFKA-8602: Separate PR for 2.3 branch (apache#7092)
  KAFKA-8530; Check for topic authorization errors in OffsetFetch response (apache#6928)
  KAFKA-8662; Fix producer metadata error handling and consumer manual assignment (apache#7086)
  KAFKA-8637: WriteBatch objects leak off-heap memory (apache#7050)
  KAFKA-8620: fix NPE due to race condition during shutdown while rebalancing (apache#7021)
  HOT FIX: close RocksDB objects in correct order (apache#7076)
  KAFKA-7157: Fix handling of nulls in TimestampConverter (apache#7070)
  KAFKA-6605: Fix NPE in Flatten when optional Struct is null (apache#5705)
  Fixes apache#8198 KStreams testing docs use non-existent method pipe (apache#6678)
  KAFKA-5998: fix checkpointableOffsets handling (apache#7030)
  KAFKA-8653; Default rebalance timeout to session timeout for JoinGroup v0 (apache#7072)
  KAFKA-8591; WorkerConfigTransformer NPE on connector configuration reloading (apache#6991)
  MINOR: add upgrade text (apache#7013)
  Bump version to 2.3.1-SNAPSHOT
@chia7712 chia7712 deleted the fix_javadoc branch March 25, 2024 15:23
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.

2 participants