Fix misleading comment on water_cells in dig_rivers.py#83
Merged
Conversation
Merged
Co-authored-by: spiani <8956990+spiani@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [WIP] Address feedback on removing ob indices from the implementation
Fix misleading comment on Mar 12, 2026
water_cells in dig_rivers.py
There was a problem hiding this comment.
Pull request overview
Updates an outdated inline comment in dig_rivers.py so it accurately describes the water_cells precomputation and its later role in skipping already-underwater cells during river intersection tracking.
Changes:
- Replaced a stale “open side” comment with an accurate description of
water_cells(underwater/negative bathymetry). - Clarified why the boolean mask is computed (used later when recording dig cells for intersection detection).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The comment preceding the
water_cellscomputation referred to checking "open sides" — logic that was already removed — leaving a stale, inaccurate description that would confuse future maintainers.Changes
src/bathytools/actions/dig_rivers.py: Replaced the outdated# Check if a side is "open"comment with an accurate description of whatwater_cellsis and where it's actually used:📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.