summaryrefslogtreecommitdiff
path: root/numpy/lib/npyio.py
diff options
context:
space:
mode:
authorHong Xu <hong@topbug.net>2018-05-06 11:15:49 -0700
committerHong Xu <hong@topbug.net>2018-05-06 11:15:49 -0700
commit406ccc9c574555ebdbda3de6abfc44a833f523e7 (patch)
treecee8abbcc32583791bcf56a2807a0f6f3cd84acc /numpy/lib/npyio.py
parent9eb14b74ee50f31e6cf83b14c193af0b98326c9a (diff)
downloadnumpy-406ccc9c574555ebdbda3de6abfc44a833f523e7.tar.gz
DOC: Add explanation for comments=None in loadtxt.
Diffstat (limited to 'numpy/lib/npyio.py')
-rw-r--r--numpy/lib/npyio.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py
index 97f50b5d8..76cc07ff1 100644
--- a/numpy/lib/npyio.py
+++ b/numpy/lib/npyio.py
@@ -791,8 +791,8 @@ def loadtxt(fname, dtype=float, comments='#', delimiter=None,
the data-type.
comments : str or sequence of str, optional
The characters or list of characters used to indicate the start of a
- comment. For backwards compatibility, byte strings will be decoded as
- 'latin1'. The default is '#'.
+ comment. None implies no comments. For backwards compatibility, byte
+ strings will be decoded as 'latin1'. The default is '#'.
delimiter : str, optional
The string used to separate values. For backwards compatibility, byte
strings will be decoded as 'latin1'. The default is whitespace.