Subject: | [Patch] POD nit |
The attached patch fixes some POD, which renders wrong, at least at
search.cpan.org.
Subject: | pod.patch |
diff --git a/lib/AI/Pathfinding/AStar.pm b/lib/AI/Pathfinding/AStar.pm
index 591c4f7..8d0a08f 100755
--- a/lib/AI/Pathfinding/AStar.pm
+++ b/lib/AI/Pathfinding/AStar.pm
@@ -191,7 +191,7 @@ AI::Pathfinding::AStar requires that the map object define a routine named C<get
Basically you should return an array reference like this: C<[ [$node1, $cost1, $h1], [$node2, $cost2, $h2], [...], ...];> For more information on heuristics and the best ways to calculate them, visit the links listed in the I<SEE ALSO> section below. For a very brief idea of how to write a getSurrounding routine, refer to the included tests.
-As mentioned earlier, AI::Pathfinding::AStar provides two routines named C<findPath> and C<findPathIncr>. C<findPath> requires as input the starting and target node identifiers. It is unimportant what format you choose for your node IDs. As long as they are unique, and can be distinguished by Perl's C<exists $hash{$nodeid}>, then they will work. C<findPath> then returns an array (or reference) of node identifiers representing the least expensive path to your target node. An empty array means that the target node is entirely unreacheable from the given source. C<findPathIncr> on the other hand allows you to calculate a particularly long path in chunks. C<findPathIncr> also takes the starting and target node identifiers but also accepts a C<state> variable and a maxiumum number of nodes to calculate before returning. C<findPathIncr> then returns a hash representing the current state that can then be passed back in for further processing later. The current path can be found in C<$state->{path}>.
+As mentioned earlier, AI::Pathfinding::AStar provides two routines named C<findPath> and C<findPathIncr>. C<findPath> requires as input the starting and target node identifiers. It is unimportant what format you choose for your node IDs. As long as they are unique, and can be distinguished by Perl's C<exists $hash{$nodeid}>, then they will work. C<findPath> then returns an array (or reference) of node identifiers representing the least expensive path to your target node. An empty array means that the target node is entirely unreacheable from the given source. C<findPathIncr> on the other hand allows you to calculate a particularly long path in chunks. C<findPathIncr> also takes the starting and target node identifiers but also accepts a C<state> variable and a maxiumum number of nodes to calculate before returning. C<findPathIncr> then returns a hash representing the current state that can then be passed back in for further processing later. The current path can be found in C<< $state->{path} >>.
=head1 PREREQUISITES