Skip to content

Commit 5d6e25b

Browse files
committed
Minor update to 'parse' docstring -- it actually returns a generator
1 parent bf7990a commit 5d6e25b

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

sn.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ def guess_source(path):
106106

107107

108108
def parse(path, source=None):
109-
"""Parses an openSNP file at a given location.
109+
"""Returns a generator yielding :class:`SNP` from an openSNP file
110+
at a given location.
110111
111112
:param str path: path to openSNP file, *all* formats are supported.
112113
:param str source: should be one of ``"23andme"``, ``"vcf"``,

0 commit comments

Comments
 (0)