pgr_extractVertices promoted to official #2773
Conversation
WalkthroughThe changes update the release notes and documentation for pgRouting 3.8.0 by clarifying the status of two functions. The function Changes
Possibly related PRs
Suggested labels
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🧰 Additional context used🧠 Learnings (1)📓 Common learnings⏰ Context from checks skipped due to timeout of 90000ms (1)
🔇 Additional comments (10)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
doc/topology/pgr_extractVertices.rst (1)
28-31: 🧹 Nitpick (assertive)🛠️ Refactor suggestion
Historical Version Inconsistency
In the “Version 3.3.0” section (lines 28–31), the text still says “* Function promoted to proposed.” Given that the function is now promoted to official status, this historical record could lead to confusion. Consider updating or removing this entry so that older status indications do not conflict with the current official status.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
NEWS.md(1 hunks)doc/src/release_notes.rst(1 hunks)doc/topology/pgr_extractVertices.rst(1 hunks)doc/topology/topology-functions.rst(1 hunks)sql/topology/extractVertices.sql(0 hunks)
💤 Files with no reviewable changes (1)
- sql/topology/extractVertices.sql
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: cvvergara
PR: pgRouting/pgrouting#2744
File: doc/src/release_notes.rst:94-94
Timestamp: 2025-02-06T20:50:07.967Z
Learning: In pgRouting, changes to functions can happen at two levels:
1. SQL level - removal/addition of function signatures
2. C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
doc/topology/pgr_extractVertices.rst (1)
Learnt from: cvvergara
PR: pgRouting/pgrouting#2771
File: doc/topology/pgr_extractVertices.rst:28-35
Timestamp: 2025-02-27T23:09:12.162Z
Learning: In pgRouting documentation, historical version entries should be maintained in reverse chronological order (newest first) to provide context about the evolution of functions over time.
doc/topology/topology-functions.rst (1)
Learnt from: cvvergara
PR: pgRouting/pgrouting#2771
File: doc/topology/pgr_extractVertices.rst:28-35
Timestamp: 2025-02-27T23:09:12.162Z
Learning: In pgRouting documentation, historical version entries should be maintained in reverse chronological order (newest first) to provide context about the evolution of functions over time.
doc/src/release_notes.rst (1)
Learnt from: cvvergara
PR: pgRouting/pgrouting#2744
File: doc/src/release_notes.rst:94-94
Timestamp: 2025-02-06T20:50:07.967Z
Learning: In pgRouting, changes to functions can happen at two levels:
1. SQL level - removal/addition of function signatures
2. C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
🪛 markdownlint-cli2 (0.17.2)
NEWS.md
18-18: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (5)
doc/topology/pgr_extractVertices.rst (1)
23-27: Official Status Annotation Added
In the “Version 3.8.0” section (lines 23–27), the text now reads “* Error messages adjustment.” followed by “* Function promoted to official.” This clearly communicates the new official status and is consistent with the PR’s goals.NEWS.md (1)
18-21: Proposed Functions Section
The subsequent section “Changes on proposed functions” continues to list functions like pgr_findCloseEdges and others. This is appropriate since only pgr_extractVertices is promoted while others remain proposed.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
18-18: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
doc/topology/topology-functions.rst (1)
27-38: Inclusion in Official Section
At lines 27–38 the new entry for “:doc:pgr_extractVertices– Extracts vertex information based on the edge table information.” has been added under the list of functions that modify the database. This is a clear and correct update that aligns with the promotion.doc/src/release_notes.rst (2)
42-49: New “Promotion to official” Rubric
The release notes for pgRouting 3.8.0 now start a new rubric “Promotion to official function of pgRouting.” (lines 42–49) which includes pgr_extractVertices.
• The inclusion directive (lines 46–48) pulls in content from pgr_extractVertices.rst and ensures consistency with the dedicated documentation.
This is a good approach to keep the release notes concise while pointing to additional context.
50-57: Separation of Proposed Functions
Immediately following the official promotion section, the rubric “Changes on proposed functions” (line 50 onward) is introduced and lists pgr_findCloseEdges (and later pgr_degree). This structure clearly demarcates the functions whose status remains as proposed.
The use of include directives ensures that any further details remain synchronized with other documentation.
| .. index:: | ||
| single: Topology Family ; pgr_extractVertices | ||
| single: extractVertices - Proposed on v3.3 | ||
| single: extractVertices | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Index Entry Consistency
At line 11–13 the index is updated with a new entry “single: extractVertices”. Please confirm that this new index entry duplicates or replaces the earlier “Topology Family ; pgr_extractVertices” as intended. If the earlier entry is no longer needed, consider removing it to avoid any ambiguity.
| **Promotion to official function of pgRouting.** | ||
|
|
||
| * pgr_extractVertices | ||
|
|
||
| * Error messages adjustment. | ||
| * Function promoted to official. | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Release Note Clarity for pgr_extractVertices
The NEWS.md file now includes a heading “Promotion to official function of pgRouting.” with a subsequent listing for pgr_extractVertices that contains an “Error messages adjustment” bullet and then “* Function promoted to official.” This entry clearly reflects the new status.
A minor suggestion: Markdownlint (MD036) flagged that emphasis was used instead of a proper heading. Consider using a hash-based heading (e.g. using “###”) to improve clarity if it aligns with your formatting guidelines.
Fixes #2772 .
Changes proposed in this pull request:
@pgRouting/admins
Summary by CodeRabbit
pgr_extractVerticesfunction as officially recognized while retaining a separate section for proposed functions.pgr_extractVerticesto the documentation, describing its role in extracting vertex information based on edge table information.