[Bioperl-guts-l] [14986] bioperl-live/trunk/Bio/SearchIO.pm: Clarify result_count ( discussions on mail list per Dan Bolser and Sendu).

[Christopher John Fields]

Revision: 14986
Author:   cjfields
Date:     2008-11-11 14:29:12 -0500 (Tue, 11 Nov 2008)

Log Message:
-----------
Clarify result_count (discussions on mail list per Dan Bolser and Sendu).

Modified Paths:
--------------
    bioperl-live/trunk/Bio/SearchIO.pm

Modified: bioperl-live/trunk/Bio/SearchIO.pm
===================================================================
--- bioperl-live/trunk/Bio/SearchIO.pm	2008-11-11 19:21:45 UTC (rev 14985)
+++ bioperl-live/trunk/Bio/SearchIO.pm	2008-11-11 19:29:12 UTC (rev 14986)
@@ -398,7 +398,9 @@
 
  Title   : result_count
  Usage   : $num = $stream->result_count;
- Function: Gets the number of Blast results that have been parsed.
+ Function: Gets the number of Blast results that have been successfully parsed
+           at the point of the method call.  This is not the total # of results
+           in the file.
  Returns : integer
  Args    : none
  Throws  : none