Merge pull request numpy#13397 from Bharat123rox/fix-genfromtxt

DOC: Resolve confusion regarding hashtag in header line of csv
javidcf · May 16, 2019 · d7e1fcb · d7e1fcb
2 parents 5bf9ab9 + 6879dcd
commit d7e1fcb
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py
@@ -1717,6 +1717,16 @@ def genfromtxt(fname, dtype=float, comments='#', delimiter=None,
     array((1, 1.3, b'abcde'),
           dtype=[('intvar', '<i8'), ('fltvar', '<f8'), ('strvar', 'S5')])
 
+    An example to show comments
+
+    >>> f = StringIO('''
+    ... text,# of chars
+    ... hello world,11
+    ... numpy,5''')
+    >>> np.genfromtxt(f, dtype='S12,S12', delimiter=',')
+    array([(b'text', b''), (b'hello world', b'11'), (b'numpy', b'5')],
+      dtype=[('f0', 'S12'), ('f1', 'S12')])
+
     """
     if max_rows is not None:
         if skip_footer: