Skip to content

Commit

Permalink
docs: Fix a few typos (dpkp#2319)
Browse files Browse the repository at this point in the history
* docs: Fix a few typos

There are small typos in:
- kafka/codec.py
- kafka/coordinator/base.py
- kafka/record/abc.py
- kafka/record/legacy_records.py

Fixes:
- Should read `timestamp` rather than `typestamp`.
- Should read `minimum` rather than `miniumum`.
- Should read `encapsulated` rather than `incapsulates`.
- Should read `callback` rather than `callbak`.

* Update abc.py
  • Loading branch information
timgates42 authored Aug 4, 2023
1 parent 94901bb commit 46473ba
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion kafka/codec.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ def _detect_xerial_stream(payload):
The version is the version of this format as written by xerial,
in the wild this is currently 1 as such we only support v1.
Compat is there to claim the miniumum supported version that
Compat is there to claim the minimum supported version that
can read a xerial block stream, presently in the wild this is
1.
"""
Expand Down
2 changes: 1 addition & 1 deletion kafka/coordinator/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -952,7 +952,7 @@ def _run_once(self):
# disable here to prevent propagating an exception to this
# heartbeat thread
# must get client._lock, or maybe deadlock at heartbeat
# failure callbak in consumer poll
# failure callback in consumer poll
self.coordinator._client.poll(timeout_ms=0)

with self.coordinator._lock:
Expand Down
2 changes: 1 addition & 1 deletion kafka/record/abc.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def build(self):


class ABCRecordBatch(object):
""" For v2 incapsulates a RecordBatch, for v0/v1 a single (maybe
""" For v2 encapsulates a RecordBatch, for v0/v1 a single (maybe
compressed) message.
"""
__metaclass__ = abc.ABCMeta
Expand Down
2 changes: 1 addition & 1 deletion kafka/record/legacy_records.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ def __iter__(self):

# When magic value is greater than 0, the timestamp
# of a compressed message depends on the
# typestamp type of the wrapper message:
# timestamp type of the wrapper message:
if timestamp_type == self.LOG_APPEND_TIME:
timestamp = self._timestamp

Expand Down

0 comments on commit 46473ba

Please sign in to comment.