Skip to content

MINOR: fix docs typo#5827

Merged
mjsax merged 5 commits intoapache:trunkfrom
mjsax:minor-doc-typo
Oct 23, 2018
Merged

MINOR: fix docs typo#5827
mjsax merged 5 commits intoapache:trunkfrom
mjsax:minor-doc-typo

Conversation

@mjsax
Copy link
Copy Markdown
Member

@mjsax mjsax commented Oct 22, 2018

More detailed description of your change,
if necessary. The PR title and PR message become
the squashed commit message, so use a separate
comment to ping reviewers.

Summary of testing strategy (including rationale)
for the feature or bug fix. Unit and/or integration
tests are expected for any behaviour change and
system tests should be considered for larger changes.

Committer Checklist (excluded from commit message)

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

@mjsax
Copy link
Copy Markdown
Member Author

mjsax commented Oct 22, 2018

Call for review @guozhangwang @bbejeck @vvcephei

Need to be cherry-picked to 2.1 branch, too.

Copy link
Copy Markdown
Member

@bbejeck bbejeck left a comment

Choose a reason for hiding this comment

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

Nice catch! LGTM

@mjsax
Copy link
Copy Markdown
Member Author

mjsax commented Oct 23, 2018

@bbejeck Pushed two more commits...

Copy link
Copy Markdown
Contributor

@vvcephei vvcephei left a comment

Choose a reason for hiding this comment

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

Thanks for this! Just one super minor comment.

Comment thread docs/streams/upgrade-guide.html Outdated
<p>
We deprecated <code>KafkaStreams#close(...)</code> and replaced it with <code>KafkaStreams#close(Duration)</code> that accepts a single timeout argument
Note: the new <code>#close</code> method has improved (but slightly different) semantics than the old one.
Note: the new <code>#close(Duration)</code> method has improved (but slightly different) semantics than the old one.
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.

What do you think about removing "than the old one"? It's redundant to saying that "the new one is improved", and I think (but am not sure) that "improved/than" should be "improved/to". Since it's redundant anyway, taking it out would tighten up the sentence.

@mjsax mjsax merged commit ff3c4e2 into apache:trunk Oct 23, 2018
@mjsax mjsax deleted the minor-doc-typo branch October 23, 2018 23:48
mjsax added a commit that referenced this pull request Oct 23, 2018
Reviewers: Bill Bejeck <bill@confluent.io>, John Roesler <john@confluent.io>
@mjsax
Copy link
Copy Markdown
Member Author

mjsax commented Oct 23, 2018

Merged to trunk and cherry-picked to 2.1 branch.

pengxiaolong pushed a commit to pengxiaolong/kafka that referenced this pull request Jun 14, 2019
Reviewers: Bill Bejeck <bill@confluent.io>, John Roesler <john@confluent.io>
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.

3 participants