Promoting to official pgr_separateCrossing and pgr_separateTouching #2874
Conversation
WalkthroughThis change updates the documentation to reflect the promotion of the Changes
Assessment against linked issues
Possibly related issues
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
👮 Files not reviewed due to content moderation or server errors (1)
🧰 Additional context used🧠 Learnings (1)📓 Common learnings⏰ Context from checks skipped due to timeout of 90000ms (1)
🔇 Additional comments (3)
🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (7)
NEWS.md(1 hunks)doc/src/release_notes.rst(1 hunks)doc/topology/topology-functions.rst(1 hunks)doc/utilities/pgr_separateCrossing.rst(1 hunks)locale/en/LC_MESSAGES/pgrouting_doc_strings.po(3 hunks)locale/pot/pgrouting_doc_strings.pot(3 hunks)sql/utilities/separateCrossing.sql(0 hunks)
💤 Files with no reviewable changes (1)
- sql/utilities/separateCrossing.sql
👮 Files not reviewed due to content moderation or server errors (1)
- locale/en/LC_MESSAGES/pgrouting_doc_strings.po
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: cvvergara
PR: pgRouting/pgrouting#2771
File: doc/topology/pgr_degree.rst:28-35
Timestamp: 2025-02-27T23:08:14.497Z
Learning: In the pgRouting documentation, historical version notes should be retained to show the evolution of functions across different versions.
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.
NEWS.md (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.
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Check queries
🔇 Additional comments (4)
doc/topology/topology-functions.rst (1)
52-52: LGTM: Correctly moved to official utilities
Thepgr_separateCrossingentry has been properly relocated into theutility_officialblock, reflecting its new official status.locale/pot/pgrouting_doc_strings.pot (3)
11-11: Update to POT creation date looks good.The POT creation date has been properly updated to reflect the current changes to the template file.
3493-3494: Correctly added new entry for official pgr_separateCrossing function.This correctly adds the
pgr_separateCrossingfunction to the Utilities section of the documentation, which aligns with its promotion from proposed to official status in version 3.8.
3562-3563: Properly documented promotion in release notes.The entry appropriately documents the promotion of
pgr_separateCrossingto official status in the release notes, with a reference to the relevant issue (#2873).
cvvergara
force-pushed
the
making-official-pgr_separateCrossing-v3.8
branch
from
eb92504 to
dd5b7f7
Compare
|
Also closes #2875 |
There was a problem hiding this comment.
Actionable comments posted: 4
🔭 Outside diff range comments (1)
doc/src/release_notes.rst (1)
86-91: 🛠️ Refactor suggestionRemove outdated proposed utilities from “Proposed functions”
TheUtilitiessubsection under "Proposed functions" still lists #2848 and #2849 even though these have now been promoted. These lines should be removed to avoid confusion.- * Utilities - * `#2848 <https://github.com/pgRouting/pgrouting/issues/2848>`__: - Create pgr_separateCrossing new utility function - * `#2849 <https://github.com/pgRouting/pgrouting/issues/2849>`__: - Create of pgr_separateTouching new utility function
♻️ Duplicate comments (2)
NEWS.md (1)
38-43: 🧹 Nitpick (assertive)Add sub-bullet for consistency
Previous promotions include a “* Function promoted to official.” sub-bullet. Adding it here will match the style for other entries.* [#2873](https://github.com/pgRouting/pgrouting/issues/2873): Promoted to official pgr_separateCrossing in version 3.8 + * Function promoted to official. * [#2874](https://github.com/pgRouting/pgrouting/issues/2874): Promoted to official pgr_separateTouching in version 3.8 + * Function promoted to official.doc/utilities/pgr_separateCrossing.rst (1)
26-27: Remove stale “New proposed function” label
This line was flagged in a previous review and remains applicable here. The “New proposed function.” entry should be deleted now that the function is official.* Function promoted to official. - * New proposed function.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (9)
NEWS.md(1 hunks)doc/src/proposed.rst(0 hunks)doc/src/release_notes.rst(1 hunks)doc/topology/topology-functions.rst(1 hunks)doc/utilities/pgr_separateCrossing.rst(2 hunks)doc/utilities/pgr_separateTouching.rst(2 hunks)locale/en/LC_MESSAGES/pgrouting_doc_strings.po(3 hunks)locale/pot/pgrouting_doc_strings.pot(3 hunks)sql/utilities/separateCrossing.sql(0 hunks)
💤 Files with no reviewable changes (2)
- sql/utilities/separateCrossing.sql
- doc/src/proposed.rst
👮 Files not reviewed due to content moderation or server errors (1)
- locale/en/LC_MESSAGES/pgrouting_doc_strings.po
🧰 Additional context used
🧠 Learnings (3)
📓 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.
Learnt from: cvvergara
PR: pgRouting/pgrouting#2771
File: doc/topology/pgr_degree.rst:28-35
Timestamp: 2025-02-27T23:08:14.497Z
Learning: In the pgRouting documentation, historical version notes should be retained to show the evolution of functions across different versions.
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.
NEWS.md (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.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (4)
doc/topology/topology-functions.rst (1)
52-53: Reclassification to official utilities is correct
The entries forpgr_separateCrossingandpgr_separateTouchinghave been properly moved under theutility_officialsection, aligning with their promotion in v3.8.0.locale/pot/pgrouting_doc_strings.pot (3)
3493-3498: New utilities added to the official function list.These functions for breaking geometries that cross or touch each other have been promoted from proposed to official status in pgRouting 3.8.0.
3565-3569: Release notes updated correctly for the function promotions.The release notes properly document the promotion of both
pgr_separateCrossingandpgr_separateTouchingto official functions with their corresponding issue references.
11992-12037: Function documentation for pgr_separateCrossing and pgr_separateTouching is comprehensive.Both functions have detailed documentation explaining their purpose (auxiliary functions for separating crossing/touching edges), parameters, return types, and usage examples. This documentation should adequately support users in utilizing these newly promoted functions.
cvvergara
force-pushed
the
making-official-pgr_separateCrossing-v3.8
branch
from
c2ec2c4 to
db1db75
Compare
cvvergara
changed the title
Fixes #2873
Changes proposed in this pull request:
@pgRouting/admins
Summary by CodeRabbit
pgr_separateCrossingandpgr_separateTouchingfrom proposed to official utility functions.