You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "arpitjain099 (via GitHub)" <gi...@apache.org> on 2026/05/12 14:20:41 UTC
[PR] Fix documentation typos in protocol and upgrade guides [kafka]
arpitjain099 opened a new pull request, #22262:
URL: https://github.com/apache/kafka/pull/22262
## Summary
- Fix typos in docs:
- `implementors` -> `implementers` (protocol docs and upgrade guide)
- malformed `Optiona...` type in Streams upgrade guide corrected to `Optional<Set<Integer>> StreamPartitioner.partitions()`
## Why
Small docs-only cleanup from a focused codespell and readability pass.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Fix documentation typos in protocol and upgrade guides [kafka]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 merged PR #22262:
URL: https://github.com/apache/kafka/pull/22262
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix documentation typos in protocol and upgrade guides [kafka]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 commented on code in PR #22262:
URL: https://github.com/apache/kafka/pull/22262#discussion_r3231774255
##########
docs/design/protocol.md:
##########
@@ -208,7 +208,7 @@ The message consists of the header and body:
## Some Common Philosophical Questions
-Some people have asked why we don't use HTTP. There are a number of reasons, the best is that client implementors can make use of some of the more advanced TCP features--the ability to multiplex requests, the ability to simultaneously poll many connections, etc. We have also found HTTP libraries in many languages to be surprisingly shabby.
+Some people have asked why we don't use HTTP. There are a number of reasons, the best is that client implementers can make use of some of the more advanced TCP features--the ability to multiplex requests, the ability to simultaneously poll many connections, etc. We have also found HTTP libraries in many languages to be surprisingly shabby.
Review Comment:
sounds good :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix documentation typos in protocol and upgrade guides [kafka]
Posted by "chia7712 (via GitHub)" <gi...@apache.org>.
chia7712 commented on code in PR #22262:
URL: https://github.com/apache/kafka/pull/22262#discussion_r3231740344
##########
docs/design/protocol.md:
##########
@@ -208,7 +208,7 @@ The message consists of the header and body:
## Some Common Philosophical Questions
-Some people have asked why we don't use HTTP. There are a number of reasons, the best is that client implementors can make use of some of the more advanced TCP features--the ability to multiplex requests, the ability to simultaneously poll many connections, etc. We have also found HTTP libraries in many languages to be surprisingly shabby.
+Some people have asked why we don't use HTTP. There are a number of reasons, the best is that client implementers can make use of some of the more advanced TCP features--the ability to multiplex requests, the ability to simultaneously poll many connections, etc. We have also found HTTP libraries in many languages to be surprisingly shabby.
Review Comment:
I think `implementors` is acceptable, as it's a standard term for those providing an implementation
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix documentation typos in protocol and upgrade guides [kafka]
Posted by "arpitjain099 (via GitHub)" <gi...@apache.org>.
arpitjain099 commented on code in PR #22262:
URL: https://github.com/apache/kafka/pull/22262#discussion_r3231747973
##########
docs/design/protocol.md:
##########
@@ -208,7 +208,7 @@ The message consists of the header and body:
## Some Common Philosophical Questions
-Some people have asked why we don't use HTTP. There are a number of reasons, the best is that client implementors can make use of some of the more advanced TCP features--the ability to multiplex requests, the ability to simultaneously poll many connections, etc. We have also found HTTP libraries in many languages to be surprisingly shabby.
+Some people have asked why we don't use HTTP. There are a number of reasons, the best is that client implementers can make use of some of the more advanced TCP features--the ability to multiplex requests, the ability to simultaneously poll many connections, etc. We have also found HTTP libraries in many languages to be surprisingly shabby.
Review Comment:
Noted, I will remove the spelling updates for implementors and will just keep the one for "Optional" for docs/streams/upgrade-guide.md
Is that okay?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix documentation typos in protocol and upgrade guides [kafka]
Posted by "arpitjain099 (via GitHub)" <gi...@apache.org>.
arpitjain099 commented on PR #22262:
URL: https://github.com/apache/kafka/pull/22262#issuecomment-4442960640
Done, @chia7712: reverted the `implementors` changes in both `docs/design/protocol.md` and `docs/getting-started/upgrade.md`. The only remaining diff is the `Optional<Set<Integer>>` typo fix in `docs/streams/upgrade-guide.md`. Thanks for the catch.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org