Skip to content

docs: planners return None when there is no path, say so in :return: #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
petercorke merged 2 commits into from
Oct 11, 2026
Merged

docs: planners return None when there is no path, say so in :return: #33

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3034895
docs: planners return None when there is no path -- say so in :return:
petercorke Oct 11, 2026
dda092c
Merge branch 'main' into docs/planner-return-none
petercorke Oct 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions src/pgraph/PGraph.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1845,11 +1845,13 @@ def path_BFS(
:raises TypeError: ``S`` or ``G`` is neither a vertex nor a string
:raises KeyError: ``S`` or ``G`` is a name not in the graph
:raises ValueError: an edge on the path has no cost
:return: list of vertices from S to G inclusive, path length
:rtype: list of BaseVertex subclass, float
:return: list of vertices from S to G inclusive and path length, or
None if there is no path
:rtype: (list of BaseVertex subclass, float) or None

Returns a list of vertices that form a path from vertex ``S`` to
vertex ``G`` if possible, otherwise return None.
vertex ``G`` if possible, otherwise returns None -- so check the
result before unpacking it.

.. runblock:: pycon

Expand Down Expand Up @@ -1947,11 +1949,13 @@ def path_UCS(
:raises TypeError: ``S`` or ``G`` is neither a vertex nor a string
:raises KeyError: ``S`` or ``G`` is a name not in the graph
:raises ValueError: an edge examined during the search has no cost
:return: list of vertices from S to G inclusive, path length, tree
:rtype: list of BaseVertex subclass, float, dict
:return: list of vertices from S to G inclusive, path length and
search tree, or None if there is no path
:rtype: (list of BaseVertex subclass, float, dict) or None

Returns a list of vertices that form a path from vertex ``S`` to
vertex ``G`` if possible, otherwise return None.
vertex ``G`` if possible, otherwise returns None -- so check the
result before unpacking it.

The search tree is returned as dict that maps a vertex to its parent.

Expand Down Expand Up @@ -2067,11 +2071,13 @@ def path_Astar(
:raises TypeError: ``S`` or ``G`` is neither a vertex nor a string
:raises KeyError: ``S`` or ``G`` is a name not in the graph
:raises ValueError: an edge examined during the search has no cost
:return: list of vertices from S to G inclusive, path length, tree
:rtype: list of BaseVertex subclass, float, dict
:return: list of vertices from S to G inclusive, path length and
search tree, or None if there is no path
:rtype: (list of BaseVertex subclass, float, dict) or None

Returns a list of vertices that form a path from vertex ``S`` to
vertex ``G`` if possible, otherwise return None.
vertex ``G`` if possible, otherwise returns None -- so check the
result before unpacking it.

The search tree is returned as dict that maps a vertex to its parent.

Expand Down
Loading