[Bioperl-guts-l] [14808] bioperl-live/trunk/Bio/Tree/TreeFunctionsI.pm: deprecate findnode_by_id

[Heikki Lehvaslaiho]

Revision: 14808
Author:   heikki
Date:     2008-08-17 03:00:35 -0400 (Sun, 17 Aug 2008)

Log Message:
-----------
deprecate findnode_by_id

Modified Paths:
--------------
    bioperl-live/trunk/Bio/Tree/TreeFunctionsI.pm

Modified: bioperl-live/trunk/Bio/Tree/TreeFunctionsI.pm
===================================================================
--- bioperl-live/trunk/Bio/Tree/TreeFunctionsI.pm	2008-08-17 03:32:19 UTC (rev 14807)
+++ bioperl-live/trunk/Bio/Tree/TreeFunctionsI.pm	2008-08-17 07:00:35 UTC (rev 14808)
@@ -946,8 +946,8 @@
 =head2 findnode_by_id
 
  Title   : findnode_by_id
- Usage   : my $node = $tree->find_node_by_id($id);
- Function: Get a node by its internal id (which should be 
+ Usage   : my $node = $tree->findnode_by_id($id);
+ Function: Get a node by its id (which should be 
            unique for the tree)
  Returns : L<Bio::Tree::NodeI>
  Args    : node id
@@ -958,6 +958,8 @@
 
 sub findnode_by_id {
     my $tree = shift;
+    $tree->deprecated("use of findnode_by_id() is deprecated; ".
+		      "use find_node() instead");
     my $id = shift;
     my $rootnode = $tree->get_root_node;
     if ( ($rootnode->id) and ($rootnode->id eq $id) ) {