Skip to content

Commit 04d05f3

Browse files
authored
DOC: Io.loadmat: document uint16_codec parameter (scipy#21909)
* Expose uint16_codec parameter * Clarify versions
1 parent f6087a9 commit 04d05f3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

scipy/io/matlab/_mio.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,12 @@ def loadmat(file_name, mdict=None, appendmat=True, **kwargs):
137137
of the result and not its contents (which is identical for both output
138138
structures). If True, this automatically sets `struct_as_record` to
139139
False and `squeeze_me` to True, which is required to simplify cells.
140+
uint16_codec : str, optional
141+
The codec to use for decoding characters, which are stored as uint16
142+
values. The default uses the system encoding, but this can be manually
143+
set to other values such as 'ascii', 'latin1', and 'utf-8'. This
144+
parameter is relevant only for files stored as v6 and above, and not
145+
for files stored as v4.
140146
141147
Returns
142148
-------

0 commit comments

Comments
 (0)