-
-
Notifications
You must be signed in to change notification settings - Fork 388
Docs: Clarify pgr_createTopology edge table updates and notice (#880) #3062
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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Docs: Clarify pgr_createTopology edge table updates and notice (#880) #3062
Conversation
WalkthroughAdded documentation clarifications: a new note in "Build a routing topology" describing topology creation effects (edge/source/target modifications, potential index creation, vertices table creation) and changed phrasing to state Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@doc/src/pgRouting-concepts.rst`:
- Line 506: The sentence still reads "in this documentation ``reverse_cost`` is
used throughout." — if the PR intended to simplify, update that sentence to just
"``reverse_cost`` is used throughout." by replacing the existing phrase
containing "in this documentation ``reverse_cost`` is used throughout." with the
shorter form; otherwise, leave it as-is to keep the current wording. Ensure the
edit targets the sentence that contains the token ``reverse_cost`` so the change
is unambiguous.
- Around line 492-498: The note currently conflates pgr_createTopology and the
manual topology steps; update the note to clearly separate behaviors: state that
pgr_createTopology (now removed) accepted clean=true which conditionally wiped
and reassigned the source and target columns and could create indexes on id,
the_geom, source, target and a vertices table, whereas the manual approach using
pgr_extractVertices plus explicit UPDATE statements always overwrites source and
target unconditionally and does not automatically create indexes or a vertices
table; mention both approaches by name (pgr_createTopology, pgr_extractVertices,
UPDATE) so readers can distinguish the conditional behavior and index creation
specific to pgr_createTopology from the manual workflow.
674efe5 to
f158997
Compare
ref #880
This PR clarifies when and how pgr_createTopology updates data during topology creation.
Changes:
Added a note at the start of the “Build a routing topology” section explaining when the edge table is updated
Files changed:
-doc/src/pgRouting-concepts.rst
Notes:
Documentation-only change
No SQL signatures or C/C++ code modified
Summary by CodeRabbit