Skip to content

Commit 7e2362f

Browse files
timgates42avahuang0429
authored andcommitted
docs: Fix a few typos
There are small typos in: - amazon_kclpy/dispatch.py - amazon_kclpy/kcl.py - amazon_kclpy/messages.py - samples/amazon_kclpy_helper.py - samples/sample_kclpy_app.py Fixes: - Should read `record` rather than `recod`. - Should read `preceded` rather than `preceeded`. - Should read `officially` rather than `officialy`. - Should read `disaggregated` rather than `deaggregated`. - Should read `callable` rather than `callabe`. - Should read `because` rather than `becasue`. - Should read `appropriate` rather than `appropiate`.
1 parent 650d92d commit 7e2362f

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

amazon_kclpy/dispatch.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def message_decode(json_dict):
3636
:return: an object that can be used to dispatch the received JSON command
3737
:rtype: amazon_kclpy.messages.MessageDispatcher
3838
39-
:raises MalformedAction: if the JSON object is missing action, or an appropiate serializer for that
39+
:raises MalformedAction: if the JSON object is missing action, or an appropriate serializer for that
4040
action can't be found
4141
"""
4242
try:

amazon_kclpy/kcl.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def __init__(self, input_file, output_file, error_file):
3030

3131
def write_line(self, line):
3232
"""
33-
Writes a line to the output file. The line is preceeded and followed by a new line because other libraries
33+
Writes a line to the output file. The line is preceded and followed by a new line because other libraries
3434
could be writing to the output file as well (e.g. some libs might write debugging info to STDOUT) so we would
3535
like to prevent our lines from being interlaced with other messages so the MultiLangDaemon can understand them.
3636
@@ -65,7 +65,7 @@ def load_action(self, line):
6565
'{"action" : "initialize", "shardId" : "shardId-000001"}')
6666
6767
:rtype: amazon_kclpy.messages.MessageDispatcher
68-
:return: A callabe action class that contains the action presented in the line
68+
:return: A callable action class that contains the action presented in the line
6969
"""
7070
return json.loads(line, object_hook=dispatch.message_decode)
7171

amazon_kclpy/messages.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ def dispatch(self, checkpointer, record_processor):
281281
"""
282282
Dispatches the shard ended message to the record processor
283283
284-
:param checkpointer: the checkpointer to be used to officialy end processing on the shard
284+
:param checkpointer: the checkpointer to be used to officially end processing on the shard
285285
:param record_processor: the record processor that will handle the shard end message
286286
"""
287287
self._checkpointer = checkpointer
@@ -376,7 +376,7 @@ def error(self):
376376

377377
class Record(object):
378378
"""
379-
Represents a single record as returned by Kinesis, or Deaggregated from the Kinesis Producer Library
379+
Represents a single record as returned by Kinesis, or Disaggregated from the Kinesis Producer Library
380380
"""
381381
def __init__(self, json_dict):
382382
"""
@@ -428,7 +428,7 @@ def sequence_number(self):
428428
@property
429429
def sub_sequence_number(self):
430430
"""
431-
The sub-sequence number of this record. This is only populated when the record is a deaggregated
431+
The sub-sequence number of this record. This is only populated when the record is a disaggregated
432432
record produced by the `amazon-kinesis-producer-library <https://github.com/awslabs/amazon-kinesis-producer>`
433433
434434
:return: the sub-sequence number

samples/amazon_kclpy_helper.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ def get_kcl_app_command(args, multi_lang_daemon_class, properties, log_configura
105105
return "{java} -cp {cp} {daemon} {props} {log_config}".format(java=args.java,
106106
cp = get_kcl_classpath(args.properties, paths),
107107
daemon = multi_lang_daemon_class,
108-
# Just need the basename becasue the path is added to the classpath
108+
# Just need the basename because the path is added to the classpath
109109
props = properties,
110110
log_config = log_configuration)
111111

samples/sample_kclpy_app.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def process_record(self, data, partition_key, sequence_number, sub_sequence_numb
8585
Called for each record that is passed to process_records.
8686
8787
:param str data: The blob of data that was contained in the record.
88-
:param str partition_key: The key associated with this recod.
88+
:param str partition_key: The key associated with this record.
8989
:param int sequence_number: The sequence number associated with this record.
9090
:param int sub_sequence_number: the sub sequence number associated with this record.
9191
"""

0 commit comments

Comments
 (0)