Skip to content

Conversation

@cvvergara
Copy link
Member

@cvvergara cvvergara commented Apr 29, 2025

Changes proposed in this pull request:

  • Removing unused SQL/legacy files from early versions of 2.x
  • On SQL comments of experimental functions/signatures
    • Adding/Standardizing PROPOSED/EXPERIENTAL keyword

@pgRouting/admins

Summary by CodeRabbit

  • New Features

    • Added local table of contents navigation to the pgRouting 3.7 release notes section.
  • Bug Fixes

    • Corrected function comments and documentation labels for clarity and consistency.
    • Updated test expectations and ordering for dominator tree and degree metric tests.
  • Refactor

    • Simplified and updated test queries and expected results for migration and TRSP-related functions.
    • Adjusted internal function calls to improve parameter handling in Dijkstra and related pathfinding functions.
    • Updated configuration and test file ordering for improved maintainability.
  • Chores

    • Removed numerous deprecated and legacy SQL functions, developer utilities, and experimental features.
    • Cleaned up extraneous blank lines and improved formatting in SQL and documentation files.
    • Updated .gitignore to exclude additional development files.
    • Improved developer tooling by making test scripts use the current PostgreSQL user dynamically.

- Removing unused SQL/legacy files from early versions of 2.x
- On SQL comments of experimental functions/signatures
  - Adding/Standardizing PROPOSED/EXPERIENTAL keyword
@cvvergara cvvergara added this to the Release 3.8.0 milestone Apr 29, 2025
@cvvergara cvvergara requested a review from robe2 April 29, 2025 15:46
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 29, 2025

Walkthrough

This update removes a significant number of legacy and deprecated SQL files and functions from the codebase, particularly those related to older routing algorithms, developer utilities, and experimental features. Several function comments and documentation blocks are updated to reflect current status labels such as "PROPOSED" or "EXPERIMENTAL." Internal SQL function calls are refactored to adjust parameters, and test files are updated for consistency in ordering and expected results. Additionally, developer tooling scripts are improved for flexibility, and minor formatting and documentation enhancements are made throughout the project.

Changes

File(s) / Path(s) Change Summary
.gitignore Added .vscode and taptest.sh to ignore list.
NEWS.md Inserted a blank line after the "pgRouting 3.7" heading.
configuration.conf Removed the "deprecated" directory from SQL-only directories.
doc/src/release_notes.rst Added a local table of contents for the pgRouting 3.7 section.
docqueries/src/migration.pg, docqueries/src/migration.result Removed deprecated function calls and outputs, simplified and updated test queries, changed arrays, and eliminated references to old restrictions.
docqueries/src/test.conf Reordered test files: moved "concepts.pg" and "migration.pg" to the beginning.
pgtap/dominator/lengauerTarjanDominatorTree/edge_cases.pg Adjusted ordering and expected results in dominator tree edge case tests.
pgtap/metrics/degree/edge_cases.pg Removed a todo check for PostgreSQL version 3.8.0+.
sql/contraction/contractionHierarchies.sql Fixed formatting in comment for "EXPERIMENTAL" status.
sql/contraction/deadEndContraction.sql, sql/contraction/linearContraction.sql Added "PROPOSED" status to function comments.
sql/dijkstra/dijkstra.sql, sql/dijkstra/dijkstraCost.sql, sql/dijkstra/dijkstraCostMatrix.sql, sql/dijkstra/dijkstraNear.sql Updated internal _pgr_dijkstra function calls to include new parameters and flags.
sql/driving_distance/_drivingDistance.sql, sql/spanningTree/_prim.sql, sql/withPoints/withPointsCostMatrix.sql, sql/trsp/_trsp.sql Cleaned up blank lines and separators for formatting.
sql/legacy/alpha_shape.sql, sql/legacy/legacy-developers.sql, sql/legacy/legacy_experimental.sql, sql/legacy/pgrouting_version.sql, sql/legacy/pointsAsPolygon.sql, sql/legacy/routing_legacy.sql, sql/legacy/tsp/TSPeucledian.sql, sql/legacy/tsp/_makeDistanceMatrix.sql, sql/legacy/tsp/tsp_v2.0_coordinates.sql, sql/legacy/tsp/tsp_v2.0_matrix.sql, sql/legacy/vrppdtw/_gsoc_vrppdtw.sql, sql/legacy/vrppdtw/gsoc_vrppdtw.sql Deleted legacy and deprecated SQL files and all functions/types within them.
sql/lineGraph/lineGraph.sql, sql/metrics/betweennessCentrality.sql Updated function comments to include or change status labels.
sql/max_flow/maxFlowMinCost.sql, sql/max_flow/maxFlowMinCost_Cost.sql Removed "EXPERIMENTAL" prefix from function comments.
sql/topology/nodeNetwork.sql Updated COMMENT ON FUNCTION to correctly reference and deprecate pgr_nodeNetwork.
sql/trsp/trsp_withPoints.sql, sql/withPoints/withPointsCost.sql Added "- PROPOSED" tag to function comments for certain overloads.
tools/developer/run.sh Added CMake config path example and replaced hardcoded username with $PGUSER in test script.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SQL_Functions
    participant Internal_Functions

    User->>SQL_Functions: Calls public routing function (e.g., pgr_dijkstra)
    SQL_Functions->>Internal_Functions: Calls _pgr_dijkstra with updated parameters
    Internal_Functions-->>SQL_Functions: Returns results
    SQL_Functions-->>User: Returns processed results
Loading

Possibly related PRs

Suggested labels

Code Cleanup, Documentation, Legacy

Suggested reviewers

  • robe2

Poem

A rabbit hopped through legacy code,
Sweeping old functions off the road.
With comments crisp and tests aligned,
The codebase now is redefined!
No more the ghosts of features past—
This garden’s clean and built to last.
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 335c9a9 and 6d5d20b.

📒 Files selected for processing (41)
  • .gitignore (1 hunks)
  • NEWS.md (1 hunks)
  • configuration.conf (0 hunks)
  • doc/src/release_notes.rst (1 hunks)
  • docqueries/src/migration.pg (2 hunks)
  • docqueries/src/migration.result (2 hunks)
  • docqueries/src/test.conf (1 hunks)
  • pgtap/dominator/lengauerTarjanDominatorTree/edge_cases.pg (3 hunks)
  • pgtap/metrics/degree/edge_cases.pg (0 hunks)
  • sql/contraction/contractionHierarchies.sql (1 hunks)
  • sql/contraction/deadEndContraction.sql (1 hunks)
  • sql/contraction/linearContraction.sql (1 hunks)
  • sql/deprecated/CMakeLists.txt (0 hunks)
  • sql/dijkstra/dijkstra.sql (5 hunks)
  • sql/dijkstra/dijkstraCost.sql (5 hunks)
  • sql/dijkstra/dijkstraCostMatrix.sql (1 hunks)
  • sql/dijkstra/dijkstraNear.sql (2 hunks)
  • sql/driving_distance/_drivingDistance.sql (0 hunks)
  • sql/legacy/alpha_shape.sql (0 hunks)
  • sql/legacy/legacy-developers.sql (0 hunks)
  • sql/legacy/legacy_experimental.sql (0 hunks)
  • sql/legacy/pgrouting_version.sql (0 hunks)
  • sql/legacy/pointsAsPolygon.sql (0 hunks)
  • sql/legacy/routing_legacy.sql (0 hunks)
  • sql/legacy/tsp/TSPeucledian.sql (0 hunks)
  • sql/legacy/tsp/_makeDistanceMatrix.sql (0 hunks)
  • sql/legacy/tsp/tsp_v2.0_coordinates.sql (0 hunks)
  • sql/legacy/tsp/tsp_v2.0_matrix.sql (0 hunks)
  • sql/legacy/vrppdtw/_gsoc_vrppdtw.sql (0 hunks)
  • sql/legacy/vrppdtw/gsoc_vrppdtw.sql (0 hunks)
  • sql/lineGraph/lineGraph.sql (1 hunks)
  • sql/max_flow/maxFlowMinCost.sql (2 hunks)
  • sql/max_flow/maxFlowMinCost_Cost.sql (2 hunks)
  • sql/metrics/betweennessCentrality.sql (1 hunks)
  • sql/spanningTree/_prim.sql (0 hunks)
  • sql/topology/nodeNetwork.sql (1 hunks)
  • sql/trsp/_trsp.sql (0 hunks)
  • sql/trsp/trsp_withPoints.sql (1 hunks)
  • sql/withPoints/withPointsCost.sql (2 hunks)
  • sql/withPoints/withPointsCostMatrix.sql (0 hunks)
  • tools/developer/run.sh (2 hunks)
💤 Files with no reviewable changes (19)
  • pgtap/metrics/degree/edge_cases.pg
  • sql/trsp/_trsp.sql
  • sql/withPoints/withPointsCostMatrix.sql
  • sql/spanningTree/_prim.sql
  • sql/driving_distance/_drivingDistance.sql
  • sql/deprecated/CMakeLists.txt
  • sql/legacy/vrppdtw/gsoc_vrppdtw.sql
  • sql/legacy/tsp/tsp_v2.0_coordinates.sql
  • sql/legacy/alpha_shape.sql
  • sql/legacy/tsp/TSPeucledian.sql
  • configuration.conf
  • sql/legacy/tsp/tsp_v2.0_matrix.sql
  • sql/legacy/vrppdtw/_gsoc_vrppdtw.sql
  • sql/legacy/pgrouting_version.sql
  • sql/legacy/pointsAsPolygon.sql
  • sql/legacy/tsp/_makeDistanceMatrix.sql
  • sql/legacy/legacy_experimental.sql
  • sql/legacy/legacy-developers.sql
  • sql/legacy/routing_legacy.sql
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
NEWS.md

117-117: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: macos (macos-latest)
  • GitHub Check: macos (macos-14)
  • GitHub Check: Ubuntu Boost (84)
  • GitHub Check: Ubuntu Boost (80)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (29)
sql/topology/nodeNetwork.sql (1)

232-233: Deprecation comment added for pgr_nodeNetwork
The new COMMENT ON FUNCTION correctly marks pgr_nodeNetwork(TEXT, DOUBLE PRECISION, TEXT, TEXT, TEXT, TEXT, BOOLEAN) as deprecated in v3.8.0, matching the in-function RAISE WARNING.

doc/src/release_notes.rst (1)

149-151: Improve navigation with local table of contents.

Adding a table of contents for the pgRouting 3.7 section enhances document navigation and matches the structure used in other version sections of the documentation.

pgtap/dominator/lengauerTarjanDominatorTree/edge_cases.pg (3)

140-140: Add deterministic ordering to query results.

Adding the ORDER BY id clause ensures consistent query results, which is important for deterministic test outcomes. This is a good practice for test stability.


159-159: Update expected test results to match corrected ordering.

The test expectation has been updated to match the corrected order of the dominator tree results when using vertex 5 as the root. This ensures tests pass consistently.


169-169: Update expected test results for different root vertex.

The expected results for the dominator tree with vertex 15 as root have been updated to match the actual results produced by the algorithm. This ensures tests pass consistently.

docqueries/src/test.conf (1)

6-7: Reorder test files for better execution sequence.

Moving 'concepts.pg' and 'migration.pg' to the beginning of the test sequence is a logical change, especially if these tests cover foundational concepts that other tests may depend on.

This reordering aligns with the PR objective of standardizing EXPERIMENTAL keywords and cleaning up deprecated SQL files, as these files likely contain important baseline documentation tests.

docqueries/src/migration.pg (2)

128-128: Query simplification looks good.

This change replaces hardcoded values with a more maintainable query that selects from the pointsOfInterest table. This aligns with modern SQL best practices and the PR's cleanup goals.


141-143: The parameter consistency update is appropriate.

The modification correctly standardizes the query parameter to use the pointsOfInterest table instead of hardcoded values, making the test more maintainable and consistent with other changes in this file.

docqueries/src/migration.result (2)

305-311: Output matches the updated query.

This new result set correctly reflects the output of the simplified query in the corresponding .pg file that selects from the pointsOfInterest table for PIDs 3, 4, and 6.


341-343: Results updated to match the modified parameters.

These output changes correctly reflect the modifications made to the function parameters in the corresponding .pg file. The values now use the standardized approach of querying the pointsOfInterest table instead of using hardcoded values.

Also applies to: 346-347, 350-351, 357-358

sql/lineGraph/lineGraph.sql (1)

54-54: Add PROPOSED label in function comment.
Standardizing the maturity annotation for pgr_lineGraph ensures consistency across documentation.

sql/contraction/linearContraction.sql (1)

47-47: Add PROPOSED tag to function comment.
Adding the “- PROPOSED” line clarifies the proposed status of this contraction function, maintaining consistency across modules.

sql/metrics/betweennessCentrality.sql (1)

51-51: Flag function as EXPERIMENTAL.
Marking pgr_betweennessCentrality as experimental aligns its documentation with project standards for stability level.

sql/contraction/contractionHierarchies.sql (1)

66-66: Standardize EXPERIMENTAL tag formatting.
Updating the comment to include “- EXPERIMENTAL” ensures uniform maturity indicators across SQL modules.

sql/contraction/deadEndContraction.sql (1)

47-47: Insert PROPOSED label in function comment.
This change adds the “- PROPOSED” tag to standardize the maturity status annotation for pgr_contractionDeadEnd.

sql/withPoints/withPointsCost.sql (2)

206-219: Add “PROPOSED” tag to Many to Many overload comment
The inserted - PROPOSED line clarifies the development status of the Many-to-Many variant and aligns it with the existing documentation style for other overloads.


221-233: Add “PROPOSED” tag to Combinations overload comment
Including the - PROPOSED marker standardizes the status annotation for the Combinations variant, matching the style of other function variants.

sql/trsp/trsp_withPoints.sql (1)

269-283: Add “PROPOSED” tag to Combinations overload comment
The new - PROPOSED line brings the Combinations overload’s comment in line with the other variants, ensuring consistent status labeling across all function signatures.

sql/max_flow/maxFlowMinCost_Cost.sql (2)

143-152: Separate “EXPERIMENTAL” tag from function name for Many to Many overload
Removing the experimental prefix from the function name and retaining it on its own line improves readability and matches the documentation conventions used elsewhere.


154-162: Separate “EXPERIMENTAL” tag from function name for Combinations overload
Applying the same documentation adjustment to the Combinations variant ensures consistency across all overload comments.

sql/max_flow/maxFlowMinCost.sql (2)

183-192: Separate “EXPERIMENTAL” tag from function name for Many to Many overload
This update aligns the Many-to-Many documentation with the cleaned-up style by moving the tag to its own line.


194-202: Separate “EXPERIMENTAL” tag from function name for Combinations overload
Standardizing the Combinations overload comment by isolating the tag improves clarity and consistency in the documentation.

.gitignore (2)

13-13: Approve ignoring .vscode directory.
Excluding IDE-specific settings is a best practice to avoid committing personal workspace files.


14-14: Confirm intention behind ignoring taptest.sh.
Ensure that taptest.sh is not required for CI or downstream usage; if it should be version-controlled, please remove it from .gitignore.

sql/dijkstra/dijkstraNear.sql (2)

52-52: Verify internal _pgr_dijkstra signature update
The new boolean false argument at the end of this call must align with the updated _pgr_dijkstra parameter list (likely the “global” flag). Please confirm that the ordering and semantics of (directed, false, true, cap, false) correctly match the internal function’s signature.


79-79: Double-check _pgr_dijkstra invocation for MANY→ONE variant
Similarly, ensure that for the MANY→ONE overload the flags (directed, false, false, cap, false) map correctly to the intended behavior (e.g., directionality, reverse traversal, nth shortest, global).

sql/dijkstra/dijkstraCostMatrix.sql (1)

45-45: Confirm extended internal call parameters
You've added four literal parameters (true, true, 0, false) to _pgr_dijkstra. Please verify these flags correspond to the intended options (e.g., include reverse edges, many-to-many behavior, nth element, global) and that no arguments are misordered.

sql/dijkstra/dijkstra.sql (1)

159-159: Verify parameter count for combinations variant
For the combinations signature, the call now uses six parameters (_pgr_get_statement($1), _pgr_get_statement($2), $3, false, 0, false). Ensure this matches the intended internal overload and that no options are missing or misordered.

sql/dijkstra/dijkstraCost.sql (1)

137-137: Confirm combinations overload signature
The combinations overload now calls _pgr_dijkstra with (… $3, true, 0, false). Please ensure this argument list aligns with the internal function’s expected parameters and that no flags are inadvertently omitted.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🔭 Outside diff range comments (1)
doc/src/release_notes.rst (1)

115-117: 🧹 Nitpick (assertive)

Collapse consecutive blank lines
There are two blank lines before the <details> block (lines 116–117). To satisfy markdownlint (MD012) and keep the flow tidy, please reduce this to a single blank line.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 335c9a9 and 6d5d20b.

📒 Files selected for processing (41)
  • .gitignore (1 hunks)
  • NEWS.md (1 hunks)
  • configuration.conf (0 hunks)
  • doc/src/release_notes.rst (1 hunks)
  • docqueries/src/migration.pg (2 hunks)
  • docqueries/src/migration.result (2 hunks)
  • docqueries/src/test.conf (1 hunks)
  • pgtap/dominator/lengauerTarjanDominatorTree/edge_cases.pg (3 hunks)
  • pgtap/metrics/degree/edge_cases.pg (0 hunks)
  • sql/contraction/contractionHierarchies.sql (1 hunks)
  • sql/contraction/deadEndContraction.sql (1 hunks)
  • sql/contraction/linearContraction.sql (1 hunks)
  • sql/deprecated/CMakeLists.txt (0 hunks)
  • sql/dijkstra/dijkstra.sql (5 hunks)
  • sql/dijkstra/dijkstraCost.sql (5 hunks)
  • sql/dijkstra/dijkstraCostMatrix.sql (1 hunks)
  • sql/dijkstra/dijkstraNear.sql (2 hunks)
  • sql/driving_distance/_drivingDistance.sql (0 hunks)
  • sql/legacy/alpha_shape.sql (0 hunks)
  • sql/legacy/legacy-developers.sql (0 hunks)
  • sql/legacy/legacy_experimental.sql (0 hunks)
  • sql/legacy/pgrouting_version.sql (0 hunks)
  • sql/legacy/pointsAsPolygon.sql (0 hunks)
  • sql/legacy/routing_legacy.sql (0 hunks)
  • sql/legacy/tsp/TSPeucledian.sql (0 hunks)
  • sql/legacy/tsp/_makeDistanceMatrix.sql (0 hunks)
  • sql/legacy/tsp/tsp_v2.0_coordinates.sql (0 hunks)
  • sql/legacy/tsp/tsp_v2.0_matrix.sql (0 hunks)
  • sql/legacy/vrppdtw/_gsoc_vrppdtw.sql (0 hunks)
  • sql/legacy/vrppdtw/gsoc_vrppdtw.sql (0 hunks)
  • sql/lineGraph/lineGraph.sql (1 hunks)
  • sql/max_flow/maxFlowMinCost.sql (2 hunks)
  • sql/max_flow/maxFlowMinCost_Cost.sql (2 hunks)
  • sql/metrics/betweennessCentrality.sql (1 hunks)
  • sql/spanningTree/_prim.sql (0 hunks)
  • sql/topology/nodeNetwork.sql (1 hunks)
  • sql/trsp/_trsp.sql (0 hunks)
  • sql/trsp/trsp_withPoints.sql (1 hunks)
  • sql/withPoints/withPointsCost.sql (2 hunks)
  • sql/withPoints/withPointsCostMatrix.sql (0 hunks)
  • tools/developer/run.sh (2 hunks)
💤 Files with no reviewable changes (19)
  • sql/driving_distance/_drivingDistance.sql
  • configuration.conf
  • sql/withPoints/withPointsCostMatrix.sql
  • pgtap/metrics/degree/edge_cases.pg
  • sql/spanningTree/_prim.sql
  • sql/trsp/_trsp.sql
  • sql/legacy/pointsAsPolygon.sql
  • sql/legacy/tsp/_makeDistanceMatrix.sql
  • sql/deprecated/CMakeLists.txt
  • sql/legacy/vrppdtw/gsoc_vrppdtw.sql
  • sql/legacy/tsp/tsp_v2.0_matrix.sql
  • sql/legacy/alpha_shape.sql
  • sql/legacy/tsp/TSPeucledian.sql
  • sql/legacy/vrppdtw/_gsoc_vrppdtw.sql
  • sql/legacy/pgrouting_version.sql
  • sql/legacy/tsp/tsp_v2.0_coordinates.sql
  • sql/legacy/legacy_experimental.sql
  • sql/legacy/legacy-developers.sql
  • sql/legacy/routing_legacy.sql
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
NEWS.md

117-117: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: macos (macos-latest)
  • GitHub Check: macos (macos-14)
  • GitHub Check: Ubuntu Boost (84)
  • GitHub Check: Ubuntu Boost (80)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (30)
sql/contraction/deadEndContraction.sql (1)

47-47: Approve addition of the PROPOSED label
The new - PROPOSED line correctly marks this function as proposed and aligns with the updated status conventions in related SQL files. No functional or signature changes were introduced.

sql/lineGraph/lineGraph.sql (1)

54-54: Approve change from EXPERIMENTAL to PROPOSED
Updating the status label to - PROPOSED maintains consistency with the PR’s goal of standardizing comment keywords. The function signature and implementation remain untouched.

sql/contraction/linearContraction.sql (1)

47-47: Approve addition of the PROPOSED label
The inserted - PROPOSED comment aligns with the new documentation standard and matches related updates in other contraction modules. No logic was altered.

sql/metrics/betweennessCentrality.sql (1)

51-51: Approve addition of the EXPERIMENTAL label
Including - EXPERIMENTAL immediately under the function name clarifies its stability status. This matches the overall cleanup pattern and does not affect functionality.

sql/contraction/contractionHierarchies.sql (1)

66-66: Approve formatting adjustment for EXPERIMENTAL label
The updated spacing before - EXPERIMENTAL improves readability and is consistent with other comment blocks in this PR. No behavioral changes.

sql/withPoints/withPointsCost.sql (2)

208-208: Function tagging update: Added PROPOSED status tag.

This change correctly adds the "- PROPOSED" status indicator to the COMMENT ON FUNCTION documentation for the Many to Many variant of the pgr_withPointsCost function, consistent with the standardization of function status labeling throughout the codebase.


223-223: Function tagging update: Added PROPOSED status tag.

This change correctly adds the "- PROPOSED" status indicator to the COMMENT ON FUNCTION documentation for the Combinations variant of the pgr_withPointsCost function, consistent with the standardization of function status labeling throughout the codebase.

sql/topology/nodeNetwork.sql (1)

232-232: Corrected function comment syntax for deprecated function.

The updated COMMENT ON FUNCTION statement now correctly formats the specification for the pgr_nodeNetwork function, which aligns with the warning message on line 66 that marks this function as deprecated since v3.8.0.

pgtap/dominator/lengauerTarjanDominatorTree/edge_cases.pg (3)

140-140: Added explicit ordering to ensure deterministic test results.

Adding the ORDER BY id clause to the query ensures consistent and deterministic ordering of the results, which is necessary for the test comparisons to work reliably.


159-159: Updated expected test result to match new ordered query output.

This update to the expected result set for ltd_test5 ensures it matches the deterministic output from the query that now has an explicit ORDER BY id clause, maintaining test integrity.


169-169: Updated expected test result to match new ordered query output.

This update to the expected result set for ltd_test6 ensures it matches the deterministic output from the query that now has an explicit ORDER BY id clause, maintaining test integrity.

docqueries/src/test.conf (1)

6-7: Reordered test files to prioritize concepts and migration tests.

Moving "concepts.pg" and "migration.pg" to the beginning of the list changes the order of test execution. This is likely to ensure that fundamental concept and migration tests run first, which can help with earlier detection of issues in the test suite.

sql/trsp/trsp_withPoints.sql (1)

271-271: Add “PROPOSED” tag to Combinations overload comment
You’ve aligned the Combinations COMMENT ON FUNCTION block with the other overloads by adding the “- PROPOSED” status line. This keeps the documentation consistent across all pgr_trsp_withPoints variants.

sql/dijkstra/dijkstraNear.sql (2)

52-52: Extend internal _pgr_dijkstra call with new control flags
The ONE-to-MANY overload now passes directed, false, true, cap, false to _pgr_dijkstra, matching the updated signature used across other Dijkstra functions.


79-79: Extend internal _pgr_dijkstra call with new control flags
The MANY-to-ONE overload now includes the additional boolean and integer flags (directed, false, false, cap, false), keeping it in sync with the ONE-to-MANY variant.

sql/dijkstra/dijkstraCostMatrix.sql (1)

45-45: Standardize _pgr_dijkstra invocation by adding flags
The pgr_dijkstraCostMatrix body now calls _pgr_dijkstra(..., directed, true, true, 0, false), aligning its internal signature with the rest of the Dijkstra cost functions.

sql/dijkstra/dijkstra.sql (2)

56-56: Append new flags to internal _pgr_dijkstra calls in the main overloads
All four routing variants (ONE-TO-ONE, ONE-TO-MANY, MANY-TO-ONE, MANY-TO-MANY) have been updated to pass the extra boolean and integer parameters (false, [true|false], 0, false) to _pgr_dijkstra, ensuring consistency with the expanded internal API.

Also applies to: 82-82, 108-108, 134-134


159-159: Extend Combinations overload to include control flags
The COMBINATIONS overload now passes false, 0, false after the directed argument, bringing it in line with other overloads’ use of the new flags.

sql/dijkstra/dijkstraCost.sql (2)

46-46: Append control flags to _pgr_dijkstra in cost overloads
The ONE-TO-ONE, ONE-TO-MANY, MANY-TO-ONE, and MANY-TO-MANY variants of pgr_dijkstraCost now uniformly pass true, true, 0, false to _pgr_dijkstra, matching the pattern in other modules.

Also applies to: 69-69, 93-93, 117-117


137-137: Extend Combinations overload with new flags
The COMBINATIONS variant now includes true, 0, false after directed, aligning its internal call signature with the other cost functions.

docqueries/src/migration.pg (2)

128-128: Added new query to display point data.

The change adds a new SELECT statement to retrieve and display point data from the pointsOfInterest table for the specific points used in subsequent queries. This provides better documentation and context for the following examples.


141-143: Updated point selection query and via points array for consistency.

This change updates the SQL subquery and parameters in the pgr_withPointsVia function call to match the points used in other examples in the file, ensuring consistency in test data. The query now uses the same points (3, 4, 6) and matching negative IDs (-4, -3, -6) across all related test cases.

docqueries/src/migration.result (2)

305-311: Added result set for the new query.

This addition shows the expected output from the new SELECT query that retrieves point data. This output serves as documentation for the test data being used in the examples.


341-358: Updated result set for the modified function call.

The result set has been updated to match the output of the modified pgr_withPointsVia function call, reflecting the changes in the points selection (using points 3, 4, 6) and corresponding negative IDs (-4, -3, -6) as parameters. The changes in lines 346, 350-352, and 357 update the node IDs and edge references to match the new test data.

doc/src/release_notes.rst (1)

149-152: Add local TOC for pgRouting 3.7 section
Introducing a localized table of contents right after the pgRouting 3.7 heading improves navigation consistency with other release sections (3.8, 3, etc.).

NEWS.md (1)

4-4: Improve section separation
The newly added blank line after the ## pgRouting 3.7 heading helps visually delineate sections and aligns spacing with adjacent release entries.

sql/max_flow/maxFlowMinCost_Cost.sql (2)

143-152: Approve removal of ‘EXPERIMENTAL’ prefix in Many-to-Many overload comment
The initial “EXPERIMENTAL” prefix has been correctly stripped from the comment string for the Many-to-Many variant, aligning it with the other overloads.


154-162: Approve removal of ‘EXPERIMENTAL’ prefix in Combinations overload comment
The “EXPERIMENTAL” prefix is gone from the Combinations overload’s comment, matching the new standardized style.

sql/max_flow/maxFlowMinCost.sql (2)

183-192: Approve removal of ‘EXPERIMENTAL’ prefix in Many-to-Many overload comment
The prefix has been removed from the Many-to-Many comment string, keeping it consistent with the updated documentation pattern.


194-202: Approve removal of ‘EXPERIMENTAL’ prefix in Combinations overload comment
The Combinations overload comment no longer starts with “EXPERIMENTAL,” which aligns with the other function comments.

@cvvergara cvvergara merged commit e710859 into pgRouting:main Apr 29, 2025
26 checks passed
@cvvergara cvvergara deleted the doing-some-fixes-before-release branch April 29, 2025 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants