Skip to content

Commit 4a79b53

Browse files
author
Andrew Yang
committed
Small edit docstring
1 parent 160e6d9 commit 4a79b53

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/diffpy/utils/parsers/loaddata.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def loadData(filename, minrows=10, headers=False, hdel='=', hignore=None, **kwar
2727
minrows -- minimum number of rows in the first data block.
2828
All rows must have the same number of floating point values.
2929
headers -- when true (default False), the function instead returns
30-
a dictionary of parameters specified in header.
30+
a dictionary of values specified in header.
3131
hdel -- (only used when headers enabled) delimiter for parsing header
3232
information.
3333
hignore -- (only used when headers enabled) ignore header rows beginning
@@ -43,8 +43,9 @@ def loadData(filename, minrows=10, headers=False, hdel='=', hignore=None, **kwar
4343
Note transposing the loaded array as loadData(FILENAME).T
4444
has the same effect.
4545
46-
Return a numpy array of the data.
47-
See also numpy.loadtxt for more details.
46+
Return a numpy array of the data. (See also numpy.loadtxt for more details.)
47+
If headers enabled, instead returns a dictionary of values read from header
48+
information.
4849
"""
4950
from numpy import array, loadtxt
5051
# for storing header data

0 commit comments

Comments
 (0)