Skip to content

GitLab

graph-tool
graph-tool

Please use the issue tracker only to report bugs (i.e. problems that need to be fixed). For questions about how to use the library, please use the mailing list at https://graph-tool.skewed.de/mailing

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

Closed
Opened by jeremyherbert@jeremyherbert
Report abuse New issue

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.