Permalink
Browse files

Version bump, documentation updates

  • Loading branch information...
1 parent 36799b0 commit 02656adeac7808e8f81f8cff3ea5cf3e84c1f0d5 James Casbon committed Jun 11, 2012
Showing with 24 additions and 3 deletions.
  1. +11 −0 docs/FILTERS.rst
  2. +6 −0 docs/HISTORY.rst
  3. +1 −1 vcf/__init__.py
  4. +6 −2 vcf/utils.py
View
@@ -94,3 +94,14 @@ The filter base class: vcf.filters.Base
.. autoclass:: vcf.filters.Base
:members:
+
+
+Utilities
+=========
+
+.. automodule:: vcf.utils
+
+Simultaneously iterate two or more files
+----------------------------------------
+
+.. autofunction:: vcf.utils.walk_together
View
@@ -17,6 +17,12 @@ New features should have test code sent with them.
Changes
=======
+0.4.5 Release
+-------------
+
+* Support exponent syntax qual values (#43, #44) (thanks @martijnvermaat)
+* Preserve order of header lines (#45)
+
0.4.4 Release
-------------
View
@@ -168,4 +168,4 @@
from filters import Base as Filter
from parser import RESERVED_INFO, RESERVED_FORMAT
-VERSION = '0.4.4'
+VERSION = '0.4.5'
View
@@ -1,7 +1,11 @@
+"""
+Utilities for VCF files.
+"""
def walk_together(*readers):
- """ Walk a set of readers and return lists of records from each
+ """ Simultaneously iteratate two or more VCF readers and return
+ lists of concurrent records from each
reader, with None if no record present. Caller must check the
inputs are sorted in the same way and use the same reference
otherwise behaviour is undefined.
@@ -18,7 +22,7 @@ def walk_together(*readers):
# update nexts that we just yielded
for i, n in enumerate(nexts):
-
+
if n is not None and n == min_next:
try:
nexts[i] = readers[i].next()

0 comments on commit 02656ad

Please sign in to comment.