Skip to content

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

Merged
petercorke merged 2 commits into
mainfrom
docs/planner-return-none
Oct 11, 2026
Merged

petercorke merged 2 commits into
mainfrom
docs/planner-return-none

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Stacked on #26 (test/self-loops-parallel-edges): the base of this PR is that branch.

Summary

Documentation only. The three planners (path_BFS, path_UCS, path_Astar) already return None when there is no path, but only the prose said so; :return: and :rtype: described just the success case, which invites an unpack error on None.

  • :return: / :rtype: now say "or None if there is no path".
  • The prose says to check the result before unpacking it.

No code changes.

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

Base automatically changed from test/self-loops-parallel-edges to main October 11, 2026 03:59
@codecov

codecov Bot commented Oct 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.37%. Comparing base (5beab4e) to head (dda092c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #33   +/-   ##
=======================================
  Coverage   87.37%   87.37%           
=======================================
  Files           2        2           
  Lines         800      800           
=======================================
  Hits          699      699           
  Misses        101      101           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@petercorke
petercorke merged commit cf7e537 into main Oct 11, 2026
14 checks passed
@petercorke
petercorke deleted the docs/planner-return-none branch October 11, 2026 04:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant