Skip to content

GitLab

Please use the issue tracker only to report bugs (i.e. errors in the library that need to be fixed) or feature requests.

For questions about how to compile, install or use the library, please use instead the mailing list at https://graph-tool.skewed.de/mailing
(If unsure, use the mailing list first.)



When opening new issues, please choose the BUG template from the drop-down menu, and fill out the required information.

Closed
Created by jeremyherbert@jeremyherbert

Ambiguous sentence in documentation

Hi,

I'm using graph-tool to do a simple astar search, and the documentation has the following sentence under astar_search:

heuristic : unary function (optional, default: lambda v: 1) The heuristic function that guides the search. It should take a single argument which is a Vertex, and output an estimated distance from the source vertex.

This is kind of ambiguous, because it is not clear which source vertex you are referring to. Is it the one which is passed to the original call? Or is the argument v === source vertex? (But I already know the answer)

Can I suggest the following wording? (changes bold)

heuristic : unary function (optional, default: lambda v: 1) The heuristic function that guides the search. It should take a single argument which is a Vertex, and output an estimated distance from the supplied vertex to the target vertex.