Fix 2924 standardize pgr edge coloring

[cvvergara]

Fixes #2924

Changes proposed in this pull request:

• Standardizing output columns pgr_edgeColoring to (edge,color)
• Adding migration guide of pgr_edgeColoring
• News and release notes about pgr_edgeColoring
• NEWS and release notes : Adding missing information

@pgRouting/admins

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 auto-generate unit tests to generate unit tests for 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.

[cvvergara]

@coderabbitai summary
@coderabbitai review

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

I'll gather information about this PR to provide both a summary and review for you.

---

🏁 Script executed:

#!/bin/bash
# Get PR information including title, description, and files changed
gh pr view 2925 --json title,body,files,additions,deletions,changedFiles

# Get the actual diff to understand the changes
gh pr diff 2925

Length of output: 27422

---

@cvvergara

Summary

This PR standardizes the output columns of the pgr_edgeColoring function as part of pgRouting v4.0.0. The main change is updating the function's output columns from (edge_id, color_id) to (edge, color) to align with pgRouting's standardization efforts.

Key Changes:

• Breaking Change: pgr_edgeColoring output columns changed from (edge_id, color_id) to (edge, color)
• Documentation: Comprehensive updates to function documentation, migration guides, and release notes
• Tests: All test files updated to use new column names
• SQL Function: Function signature and implementation updated

Files Changed: 18 files (279 additions, 126 deletions)

Review

✅ Strengths

1. Comprehensive Documentation: Excellent job documenting the breaking change with:

   • Clear migration instructions in doc/src/migration.rst
   • Proper version history in function documentation
   • Detailed release notes

2. Consistent Implementation: The standardization is applied consistently across:

   • Function definition (sql/coloring/edgeColoring.sql)
   • Documentation files
   • Test cases
   • Query examples

3. Proper Testing: All test files are updated to reflect the new column names, ensuring compatibility.

4. Migration Support: The upgrade script properly handles dropping the old function signature.

🔍 Observations

1. Breaking Change Management: This is properly marked as a breaking change with clear migration guidance provided.

2. Documentation Structure: The documentation follows consistent patterns with proper version annotations and rubric formatting.

3. Test Coverage: The test updates show good coverage of the functionality with both positive and edge cases.

✅ Code Quality

The implementation is clean and follows pgRouting conventions:

• SQL function simplified from PL/pgSQL to SQL language
• Proper parameter naming
• Consistent formatting

📋 Minor Suggestions

1. In doc/conf.py.in, the change from |result-edge-color| replace:: ``(edge_id, color_id)``` to |result-edge-color| replace:: ``(edge, color)``` is correct and maintains consistency.

2. The NEWS.md corrections (fixing issue references from Standardize output columns of pgr_withPoints and pgr_withPointsCost #2905 to Make official the WithPoints family of functions #2700) are good cleanup.

✅ Overall Assessment

This is a well-executed breaking change that:

• Maintains backward compatibility through proper versioning
• Provides clear migration paths
• Includes comprehensive documentation
• Updates all relevant test cases
• Follows established patterns for pgRouting standardization

The PR successfully addresses issue #2924 and contributes to the overall standardization goals for pgRouting v4.0.0.

Recommendation: ✅ Approve - This is a well-structured change with proper documentation and testing.