Skip to content

Commit e06efef

Browse files
committed
Updated method descriptions
1 parent f9c5b43 commit e06efef

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

src/nypl_py_utils/classes/avro_client.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@ class AvroDecoder(AvroClient):
119119

120120
def decode_record(self, record):
121121
"""
122-
Decodes a single record represented using the given Avro schema.
122+
Decodes a single record represented using the given Avro
123+
schema. Input must be a bytes-like object.
123124
124125
Returns a dictionary where each key is a field in the schema.
125126
"""
@@ -140,7 +141,8 @@ def decode_record(self, record):
140141

141142
def decode_batch(self, record_list):
142143
"""
143-
Decodes a list of JSON records using the given Avro schema.
144+
Decodes a list of JSON records using the given Avro schema. Input
145+
must be a list of bytes-like objects.
144146
145147
Returns a list of strings where each string is a decoded record.
146148
"""

0 commit comments

Comments
 (0)