Skip to content

Commit babbfde

Browse files
committed
minor documentation changes
1 parent 3e4eed2 commit babbfde

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/bchlib.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,8 @@ BCH_getattr(BCHObject *self, PyObject *name)
364364

365365
static PyMemberDef BCH_members[] = {
366366
{"data_len", T_UINT, offsetof(BCHObject, data_len), 0,
367-
"Read/write; decode data length. Set value before decoding."},
367+
"Read/write; decode data length in bytes. Set this value before "
368+
"decoding."},
368369
{"ecc_bits", -1, 0, READONLY|RESTRICTED,
369370
"Readonly; number of ecc bits."},
370371
{"ecc_bytes", -1, 0, READONLY|RESTRICTED,
@@ -395,7 +396,7 @@ static PyMethodDef BCH_methods[] = {
395396
"There are four ways that 'decode' can function by providing "
396397
"different\ninput parameters:\n\n 'data' and 'recv_ecc'\n"
397398
" 'recv_ecc' and 'calc_ecc'\n 'calc_ecc' (as recv_ecc XOR "
398-
"calc_ecc)\n 'syn' (a sequence of 2*t values)\n\nbch->len "
399+
"calc_ecc)\n 'syn' (a sequence of 2*t values)\n\nbch.data_len "
399400
"SHOULD be set before calling this function."},
400401
{"correct", (PyCFunction) BCH_correct, METH_VARARGS | METH_KEYWORDS,
401402
"\b\b\b\bcorrect(data=None, ecc=None) → None\nCorrects 'data' "

0 commit comments

Comments
 (0)