Update docstrings so they no longer generate warnings in Sphix.

This commit is contained in:
Dave Clements
2012-10-31 23:08:09 -07:00
parent 36c495edfc
commit 38e0065fe7
2 changed files with 13 additions and 7 deletions
+12 -7
View File
@@ -119,12 +119,13 @@ class GFFReaderWrapper( NiceReaderWrapper ):
Reader wrapper for GFF files.
Wrapper has two major functions:
(1) group entries for GFF file (via group column), GFF3 (via id attribute),
or GTF (via gene_id/transcript id);
(2) convert coordinates from GFF format--starting and ending coordinates
are 1-based, closed--to the 'traditional'/BED interval format--0 based,
half-open. This is useful when using GFF files as inputs to tools that
expect traditional interval format.
1. group entries for GFF file (via group column), GFF3 (via id attribute),
or GTF (via gene_id/transcript id);
2. convert coordinates from GFF format--starting and ending coordinates
are 1-based, closed--to the 'traditional'/BED interval format--0 based,
half-open. This is useful when using GFF files as inputs to tools that
expect traditional interval format.
"""
def __init__( self, reader, chrom_col=0, feature_col=2, start_col=3, \
@@ -303,9 +304,13 @@ def parse_gff_attributes( attr_str ):
"""
Parses a GFF/GTF attribute string and returns a dictionary of name-value
pairs. The general format for a GFF3 attributes string is
name1=value1;name2=value2
The general format for a GTF attribute string is
name1 "value1" ; name2 "value2"
The general format for a GFF attribute string is a single string that
denotes the interval's group; in this case, method returns a dictionary
with a single key-value pair, and key name is 'group'
@@ -412,4 +417,4 @@ def read_unordered_gtf( iterator, strict=False ):
for chrom_features in chroms_features_sorted:
for feature in chrom_features:
yield feature
+1
View File
@@ -7,6 +7,7 @@ class BaseJobRunner( object ):
"""
Compose the sequence of commands necessary to execute a job. This will
currently include:
- environment settings corresponding to any requirement tags
- preparing input files
- command line taken from job wrapper