Simplify NEWS.md #2864
Simplify NEWS.md #2864
Conversation
cvvergara
added
Documentation
Enhancement
Translation
WalkthroughThis set of changes focuses on restructuring and correcting documentation and translation files for pgRouting. The NEWS.md file is reorganized for better readability, with an added link to online release notes and collapsible sections for older micro releases. Numerous documentation files are updated to fix typographical and spelling errors, clarify function promotions, deprecations, and new proposals, and standardize formatting. Translation files in English, Spanish, and Chinese are updated to reflect these changes, including new function descriptions and corrections. The release notes and a supporting Perl script are modified to support the new collapsible structure for release histories. No code logic or API signatures are altered. Changes
Sequence Diagram(s)Not applicable: The changes are limited to documentation structure, spelling, and translation updates, without affecting control flow or feature logic. Assessment against linked issues
Possibly related PRs
Suggested reviewers
Poem
🪧 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: 37
🔭 Outside diff range comments (1)
locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (1)
16301-16305: 🛠️ Refactor suggestionMissing translations for pgr_separateCrossing examples
Several translations are missing for the pgr_separateCrossing usage examples.
Consider adding translations for the example usage of pgr_separateCrossing:
msgid "In this example :doc:`pgr_separateCrossing` and :doc:`pgr_separateTouching` will be used." -msgstr "" +msgstr "在本例中，将使用 :doc:`pgr_separateCrossing` 和 :doc:`pgr_separateTouching`。"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (40)
NEWS.md(40 hunks)doc/allpairs/allpairs-family.rst(1 hunks)doc/allpairs/pgr_johnson.rst(1 hunks)doc/astar/pgr_aStar.rst(1 hunks)doc/astar/pgr_aStarCost.rst(1 hunks)doc/astar/pgr_aStarCostMatrix.rst(1 hunks)doc/bdAstar/pgr_bdAstar.rst(1 hunks)doc/bdAstar/pgr_bdAstarCost.rst(1 hunks)doc/bdAstar/pgr_bdAstarCostMatrix.rst(1 hunks)doc/bdDijkstra/pgr_bdDijkstraCost.rst(1 hunks)doc/categories/VRP-category.rst(3 hunks)doc/categories/withPoints-category.rst(8 hunks)doc/circuits/pgr_hawickCircuits.rst(3 hunks)doc/dijkstra/pgr_dijkstra.rst(2 hunks)doc/dijkstra/pgr_dijkstraCost.rst(1 hunks)doc/dijkstra/pgr_dijkstraNear.rst(2 hunks)doc/dijkstra/pgr_dijkstraNearCost.rst(3 hunks)doc/dominator/pgr_lengauerTarjanDominatorTree.rst(1 hunks)doc/driving_distance/pgr_drivingDistance.rst(2 hunks)doc/ksp/pgr_KSP.rst(1 hunks)doc/lineGraph/pgr_lineGraphFull.rst(2 hunks)doc/max_flow/pgr_edmondsKarp.rst(1 hunks)doc/spanningTree/pgr_kruskalBFS.rst(1 hunks)doc/spanningTree/pgr_kruskalDD.rst(1 hunks)doc/spanningTree/pgr_kruskalDFS.rst(1 hunks)doc/spanningTree/pgr_primBFS.rst(1 hunks)doc/spanningTree/pgr_primDD.rst(1 hunks)doc/spanningTree/pgr_primDFS.rst(1 hunks)doc/src/release_notes.rst(2 hunks)doc/transitiveClosure/pgr_transitiveClosure.rst(1 hunks)doc/tsp/pgr_TSP.rst(3 hunks)doc/tsp/pgr_TSPeuclidean.rst(3 hunks)doc/withPoints/pgr_withPoints.rst(6 hunks)doc/withPoints/pgr_withPointsDD.rst(2 hunks)doc/withPoints/pgr_withPointsKSP.rst(6 hunks)locale/en/LC_MESSAGES/pgrouting_doc_strings.po(46 hunks)locale/es/LC_MESSAGES/pgrouting_doc_strings.po(74 hunks)locale/pot/pgrouting_doc_strings.pot(44 hunks)locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po(74 hunks)tools/release-scripts/notes2news.pl(1 hunks)
👮 Files not reviewed due to content moderation or server errors (1)
- locale/en/LC_MESSAGES/pgrouting_doc_strings.po
🧰 Additional context used
🧠 Learnings (7)
📓 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.
doc/withPoints/pgr_withPointsDD.rst (1)
Learnt from: cvvergara
PR: pgRouting/pgrouting#2764
File: doc/withPoints/pgr_withPoints.rst:30-35
Timestamp: 2025-02-27T16:42:23.807Z
Learning: For pgr_withPoints, the original function was proposed in version 2.2.0, while the Combinations signature overload was added in version a3.2.0.
doc/src/release_notes.rst (3)
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#2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
Learnt from: cvvergara
PR: pgRouting/pgrouting#0
File: :0-0
Timestamp: 2025-01-27T01:49:25.212Z
Learning: In pgRouting, when deprecating internal functions:
1. Add deprecation notice in C code using ereport with ERRCODE_FEATURE_NOT_SUPPORTED
2. Update tests with version checks (min_version, min_lib_version)
3. Document changes in NEWS.md under appropriate sections
NEWS.md (5)
Learnt from: cvvergara
PR: pgRouting/pgrouting#2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
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.
Learnt from: cvvergara
PR: pgRouting/pgrouting#0
File: :0-0
Timestamp: 2025-01-27T01:49:25.212Z
Learning: In pgRouting, when deprecating internal functions:
1. Add deprecation notice in C code using ereport with ERRCODE_FEATURE_NOT_SUPPORTED
2. Update tests with version checks (min_version, min_lib_version)
3. Document changes in NEWS.md under appropriate sections
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.
locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (1)
undefined
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
locale/pot/pgrouting_doc_strings.pot (3)
undefined
<retrieved_learning>
Learnt from: cvvergara
PR: #2725
File: src/dijkstra/dijkstra_driver.cpp:147-148
Timestamp: 2025-01-19T16:18:55.529Z
Learning: In pgRouting, error messages should not be modified without careful consideration as they are verified by pgtap tests. Changes to error messages require corresponding updates to test cases.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
locale/en/LC_MESSAGES/pgrouting_doc_strings.po (6)
undefined
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
🪛 LanguageTool
NEWS.md
[uncategorized] ~1-~1: You might be missing the article “the” here.
Context: To read all history of releases go to the latest [release n...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~1-~1: Make sure the noun ‘history’ is in agreement with the verb ‘go’. Beware that some collective nouns (like ‘police’ or ‘team’) can be treated as both singular and plural.
Context: To read all history of releases go to the latest [release notes](https://d...
(DT_NN_OF_NNS_VB)
🪛 markdownlint-cli2 (0.17.2)
NEWS.md
1-1: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
38-38: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
54-54: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
70-70: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
90-90: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
91-91: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
95-95: Inline HTML
Element: details
(MD033, no-inline-html)
95-95: Inline HTML
Element: summary
(MD033, no-inline-html)
98-98: Spaces inside link text
null
(MD039, no-space-in-links)
105-105: Inline HTML
Element: details
(MD033, no-inline-html)
105-105: Inline HTML
Element: summary
(MD033, no-inline-html)
128-128: Inline HTML
Element: details
(MD033, no-inline-html)
128-128: Inline HTML
Element: summary
(MD033, no-inline-html)
147-147: Inline HTML
Element: details
(MD033, no-inline-html)
147-147: Inline HTML
Element: summary
(MD033, no-inline-html)
207-207: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
208-208: Inline HTML
Element: details
(MD033, no-inline-html)
208-208: Inline HTML
Element: summary
(MD033, no-inline-html)
248-248: Inline HTML
Element: details
(MD033, no-inline-html)
248-248: Inline HTML
Element: summary
(MD033, no-inline-html)
270-270: Inline HTML
Element: details
(MD033, no-inline-html)
270-270: Inline HTML
Element: summary
(MD033, no-inline-html)
281-281: Inline HTML
Element: details
(MD033, no-inline-html)
281-281: Inline HTML
Element: summary
(MD033, no-inline-html)
399-399: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
400-400: Inline HTML
Element: details
(MD033, no-inline-html)
400-400: Inline HTML
Element: summary
(MD033, no-inline-html)
443-443: Inline HTML
Element: details
(MD033, no-inline-html)
443-443: Inline HTML
Element: summary
(MD033, no-inline-html)
463-463: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
464-464: Inline HTML
Element: details
(MD033, no-inline-html)
464-464: Inline HTML
Element: summary
(MD033, no-inline-html)
479-479: Inline HTML
Element: details
(MD033, no-inline-html)
479-479: Inline HTML
Element: summary
(MD033, no-inline-html)
494-494: Inline HTML
Element: details
(MD033, no-inline-html)
494-494: Inline HTML
Element: summary
(MD033, no-inline-html)
574-574: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
575-575: Inline HTML
Element: details
(MD033, no-inline-html)
575-575: Inline HTML
Element: summary
(MD033, no-inline-html)
582-582: Inline HTML
Element: details
(MD033, no-inline-html)
582-582: Inline HTML
Element: summary
(MD033, no-inline-html)
595-595: Inline HTML
Element: details
(MD033, no-inline-html)
595-595: Inline HTML
Element: summary
(MD033, no-inline-html)
618-618: Inline HTML
Element: details
(MD033, no-inline-html)
618-618: Inline HTML
Element: summary
(MD033, no-inline-html)
656-656: Inline HTML
Element: details
(MD033, no-inline-html)
656-656: Inline HTML
Element: summary
(MD033, no-inline-html)
671-671: Inline HTML
Element: details
(MD033, no-inline-html)
671-671: Inline HTML
Element: summary
(MD033, no-inline-html)
727-727: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
728-728: Inline HTML
Element: details
(MD033, no-inline-html)
728-728: Inline HTML
Element: summary
(MD033, no-inline-html)
742-742: Inline HTML
Element: details
(MD033, no-inline-html)
742-742: Inline HTML
Element: summary
(MD033, no-inline-html)
760-760: Inline HTML
Element: details
(MD033, no-inline-html)
760-760: Inline HTML
Element: summary
(MD033, no-inline-html)
840-840: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
841-841: Inline HTML
Element: details
(MD033, no-inline-html)
841-841: Inline HTML
Element: summary
(MD033, no-inline-html)
856-856: Inline HTML
Element: details
(MD033, no-inline-html)
856-856: Inline HTML
Element: summary
(MD033, no-inline-html)
875-875: Inline HTML
Element: details
(MD033, no-inline-html)
875-875: Inline HTML
Element: summary
(MD033, no-inline-html)
898-898: Inline HTML
Element: details
(MD033, no-inline-html)
898-898: Inline HTML
Element: summary
(MD033, no-inline-html)
922-922: Inline HTML
Element: details
(MD033, no-inline-html)
922-922: Inline HTML
Element: summary
(MD033, no-inline-html)
942-942: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
943-943: Inline HTML
Element: details
(MD033, no-inline-html)
943-943: Inline HTML
Element: summary
(MD033, no-inline-html)
958-958: Inline HTML
Element: details
(MD033, no-inline-html)
958-958: Inline HTML
Element: summary
(MD033, no-inline-html)
977-977: Inline HTML
Element: details
(MD033, no-inline-html)
977-977: Inline HTML
Element: summary
(MD033, no-inline-html)
1001-1001: Inline HTML
Element: details
(MD033, no-inline-html)
1001-1001: Inline HTML
Element: summary
(MD033, no-inline-html)
1020-1020: Inline HTML
Element: details
(MD033, no-inline-html)
1020-1020: Inline HTML
Element: summary
(MD033, no-inline-html)
1035-1035: Inline HTML
Element: details
(MD033, no-inline-html)
1035-1035: Inline HTML
Element: summary
(MD033, no-inline-html)
1050-1050: Inline HTML
Element: details
(MD033, no-inline-html)
1050-1050: Inline HTML
Element: summary
(MD033, no-inline-html)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: documentation (zh_Hans)
- GitHub Check: documentation (es)
🔇 Additional comments (170)
doc/tsp/pgr_TSPeuclidean.rst (1)
181-181: LGTM! Spelling correction from "Visualy" to "Visually"The spelling correction is appropriate.
tools/release-scripts/notes2news.pl (6)
49-52: LGTM! Added variables to track release note hierarchyGood addition of variables to track major, minor, and micro release note headers, which improves the script's ability to maintain state during processing.
54-55: LGTM! Added link to latest release notesThe addition of a link to the latest online release notes at the beginning of the NEWS.md file provides valuable context and improves user navigation.
60-60: LGTM! Improved line filteringGood enhancement to skip lines containing "current" in addition to other patterns, which helps filter out irrelevant content.
67-77: LGTM! Enhanced handling of major headersGood improvement to the header processing logic for major version headers, which now closes any previously open
<details>tags and stops processing after the first major header.
79-85: LGTM! Enhanced handling of minor headersGood improvement to the header processing logic for minor version headers, which now closes any open micro-level
<details>tags before printing.
87-96: LGTM! Enhanced handling of micro headersGood improvement to the header processing logic for micro version headers, which now implements collapsible sections using
<details>and<summary>HTML tags.doc/bdAstar/pgr_bdAstarCostMatrix.rst (1)
37-37: LGTM! Spelling correction from "internaly" to "internally"The spelling correction is appropriate.
doc/astar/pgr_aStarCost.rst (1)
41-41: LGTM! Spelling correction from "sumarizes" to "summarizes"The spelling correction is appropriate.
doc/transitiveClosure/pgr_transitiveClosure.rst (1)
47-47: Typographical Correction: "compresed" → "compressed"Fixed the spelling of "compressed" in the feature list for
pgr_transitiveClosure.doc/allpairs/pgr_johnson.rst (1)
38-38: Typographical Correction: "usees" → "uses"Corrected the typo in the description to improve clarity: "It uses the Boost's implementation…".
doc/spanningTree/pgr_kruskalDD.rst (1)
28-28: Typographical Correction: "Standarizing" → "Standardizing"Fixed the spelling in the changelog entry for version 3.7.0.
doc/lineGraph/pgr_lineGraphFull.rst (2)
275-275: Typographical Correction: "Idenifying" → "Identifying"Corrected the heading text to use the proper spelling.
286-286: Typographical Correction: "previus" → "previous"Fixed the spelling in the inline description to ensure consistency.
doc/astar/pgr_aStarCostMatrix.rst (1)
38-38: Typographical Correction: "internaly" → "internally"Corrected the typo in the description of the internal use of
pgr_aStar.doc/spanningTree/pgr_primBFS.rst (1)
28-28: Correct spelling for consistency
Changing "Standarizing" to "Standardizing" aligns this release note with the terminology used across other documentation.doc/spanningTree/pgr_primDFS.rst (1)
28-28: Correct spelling for consistency
Changing "Standarizing" to "Standardizing" aligns this release note with the terminology used across other documentation.doc/spanningTree/pgr_kruskalDFS.rst (1)
28-28: Correct spelling for consistency
Changing "Standarizing" to "Standardizing" aligns this release note with the terminology used across other documentation.doc/bdAstar/pgr_bdAstar.rst (1)
25-25: Correct spelling for consistency
Changing "Standarizing" to "Standardizing" aligns this release note with the terminology used across other algorithm docs.doc/allpairs/allpairs-family.rst (1)
117-117: Correct spelling of PostgreSQL
Updating "posgreSQL" to "PostgreSQL" fixes the typo and matches the proper casing of the database name.doc/dominator/pgr_lengauerTarjanDominatorTree.rst (1)
35-35: Typographical correction in algorithm description. The spelling of “immediate” is now correct, improving documentation accuracy.doc/max_flow/pgr_edmondsKarp.rst (1)
229-229: Standardize Boost link display text. The link text has been updated to “Edmonds Karp max flow”, ensuring consistent capitalization.doc/bdAstar/pgr_bdAstarCost.rst (1)
41-41: Typo fix: correct “sumarizes” to “summarizes”. The sentence now correctly describes the function behavior.doc/spanningTree/pgr_kruskalBFS.rst (1)
28-28: Typographical correction in changelog. “Standardizing” is now correctly spelled, aligning with project-wide documentation standards.doc/astar/pgr_aStar.rst (1)
25-25: Typographical correction in changelog. The word “Standardizing” is spelled correctly, ensuring consistency across documentation.doc/dijkstra/pgr_dijkstraNearCost.rst (3)
154-154: Typographical correction: 'Unsing' → 'Using'
This change fixes the typo and standardizes the wording for clarity.
203-203: Typographical correction: 'fisrt' → 'first'
Updating the spelling to maintain professional documentation standards.
233-233: Typographical correction: 'equaly' → 'equally'
Corrects the typo to accurately convey the meaning.doc/dijkstra/pgr_dijkstraCost.rst (1)
40-40: Typographical correction: 'sumarizes' → 'summarizes'
Fixes the spelling in the function description for consistency across docs.doc/spanningTree/pgr_primDD.rst (1)
27-27: Typographical correction: 'Standarizing' → 'Standardizing'
Ensures correct spelling in the version 3.7.0 changelog entry.doc/bdDijkstra/pgr_bdDijkstraCost.rst (1)
42-42: Typographical correction: 'sumarizes' → 'summarizes'
Corrects the typo in the description of the bidirectional Dijkstra cost function.doc/dijkstra/pgr_dijkstra.rst (2)
26-26: Typographical correction: 'Standarizing' → 'Standardizing'
Fixes the spelling in the version 3.5.0 release notes.
599-599: Heading correction: 'e Also' → 'See Also'
Restores the proper heading for the references section.doc/dijkstra/pgr_dijkstraNear.rst (2)
177-178: Typo fix: 'Unsing' ➔ 'Using'.
Great catch correcting "Unsing" to "Using" for the undirected graph example.
256-257: Typo fix: 'equaly' ➔ 'equally'.
The correction from "equaly" to "equally" improves clarity in describing equally good connections.doc/ksp/pgr_KSP.rst (1)
25-26: Typo fix: 'Standarizing' ➔ 'Standardizing'.
This corrects the spelling in the Version 3.6.0 changelog entry.doc/withPoints/pgr_withPoints.rst (4)
89-90: Typo fix: 'EMTPY' ➔ 'EMPTY'.
Corrects "OR EMTPY SET" to "OR EMPTY SET" in the summary signature.
104-105: Typo fix: 'EMTPY' ➔ 'EMPTY'.
Fixed "OR EMTPY SET" to "OR EMPTY SET" for the One-to-One signature.
125-126: Typo fix: 'EMTPY' ➔ 'EMPTY'.
Corrected "OR EMTPY SET" to "OR EMPTY SET" for the Many-to-One signature.
190-191: Typo fix: 'EMTPY' ➔ 'EMPTY'.
Fixed "OR EMTPY SET" to "OR EMPTY SET" for the Combinations signature.doc/withPoints/pgr_withPointsDD.rst (2)
37-38: Typo fix: 'Standarizing' ➔ 'Standardizing'.
Good fix for the spelling in the Version 3.6.0 change entry.
54-55: Formatting cleanup for deprecated signatures.
Removing inconsistent backticks in the deprecated signature list improves formatting consistency.doc/driving_distance/pgr_drivingDistance.rst (2)
25-25: Consistent spelling correction in version note
The change corrects “Standarizing” to “Standardizing,” aligning this file with other spelling fixes in the PR.
56-56: Spelling fix in description
“spaning” is now corrected to “spanning,” improving clarity and professionalism.doc/circuits/pgr_hawickCircuits.rst (3)
19-19: Corrected function description punctuation
The em‑dash is now properly used in “pgr_hawickCircuits— Returns…” for consistency with style guidelines.
56-56: Fixed variable notation in complexity note
Corrects “:math:|c|is the number of circuits in the graph.”, matching the formatting of the previous bullet points.
120-120: Improved bullet text consistency
The result‑column description is now grammatically consistent with other entries (“Relative position…”).doc/categories/VRP-category.rst (2)
470-470: Clarified summary row description
“Summary row has the total capacity violations.” corrects and clarifies the metric labeling for the summary row.
479-479: Clarified summary row description
“Summary row has the total time window violations.” fixes grammatical number and aligns with singular “window” usage elsewhere.doc/withPoints/pgr_withPointsKSP.rst (2)
29-29: Corrected spelling in version note
“Standarizing” is now “Standardizing,” matching the style applied in all version notes.
89-90: Fixed spelling of “EMPTY” in return type notes
Corrects multiple instances of “OR EMTPY SET” to “OR EMPTY SET” for consistency and professionalism.Also applies to: 115-116, 137-138, 159-160, 181-182
doc/categories/withPoints-category.rst (2)
304-304: Approve corrected bullet in driving‑side note
“- Preferred usage on undirected graphs” is now grammatically correct.
345-345: Approve consistency of edge‑cost bullets
All instances of edge‑cost descriptions now consistently read “(the remaining cost)” and align with other examples.Also applies to: 352-352, 365-365, 393-393
locale/pot/pgrouting_doc_strings.pot (24)
11-11: Documentation timestamp update.This update changes the POT (Portable Object Template) creation date to the latest build timestamp.
1039-1039: Improved summary row description clarity.The text now more clearly describes what the summary row contains when vehicle_id is referenced.
1054-1054: Improved summary row description clarity.Similar to the previous change, this text better describes what the summary row contains for time window violations.
1426-1426: Improved documentation clarity for time unit conversions.The explanation about working with time units and the matrix has been improved for better clarity.
3529-3529: Updated release note for pgr_extractVertices promotion.This provides the reference to the GitHub issue (#2772) for tracking the promotion of pgr_extractVertices to official status in version 3.8.
3538-3538: Updated release note for pgr_degree promotion.This provides the reference to the GitHub issue (#2760) for tracking the promotion of pgr_degree to official status in version 3.8.
3544-3544: Updated release note for pgr_findCloseEdges promotion.This provides the reference to the GitHub issue (#2774) for tracking the promotion of pgr_findCloseEdges to official status in version 3.8.
3550-3550: Documentation update for new proposed functions.The section title now clearly indicates these are new proposed functions.
3556-3566: Updated documentation for new contraction functions.This section lists the new proposed contraction and utility functions with their corresponding GitHub issue references.
3572-3572: Updated release note for pgr_contraction changes.This provides the reference to the GitHub issue (#2786) for the new signature of pgr_contraction.
3589-3589: Updated release note for pgr_contraction code reorganization.This provides the reference to the GitHub issue (#2802) for the code reorganization in pgr_contraction.
3592-3596: Updated release note for SQL code enhancements.This adds information about SQL code enhancements, specifically the rewrite of pgr_nodeNetwork (issue #2850).
3598-3623: Updated documentation for deprecated functions.This section provides details about functions being deprecated in version 3.8, including references to the relevant GitHub issues.
6253-6254: Updated release note for pgr_KSP standardization.This note indicates that the output columns for pgr_KSP are being standardized to follow the |nksp-result| format.
6551-6551: Improved documentation clarity for asymmetric matrix generation.The documentation now more clearly explains that points of interest are used to generate an asymmetric matrix.
6560-6560: Improved documentation for directed graph usage.The text now explicitly states that
directed => trueis used when generating an asymmetric matrix.
11059-11059: Improved section header for restriction identification.The heading now clearly indicates that this section is about identifying restrictions.
11066-11066: Enhanced SQL condition clarity.The text now provides a more specific SQL condition to identify the edge that needs to be altered.
13389-13389: Updated release note for standardizing output columns.This documents the standardization of output columns to follow the |short-generic-result| format.
13781-13781: Documentation consistency improvement.The reference to pgr_withPointsKSP now correctly uses proper formatting with backticks.
15496-15496: Improved documentation for sample data usage.The text now more clearly references the sample data that will be used for examples of points of interest.
15526-15526: Grammar fix in documentation.Removed duplicate "the" in "In the the following images".
15568-15568: Clarified usage recommendation for undirected graphs.The documentation now explicitly recommends this option for undirected graphs.
15601-15601: Improved clarity of point arrival explanations.These changes provide clearer explanations about how arrival to points is handled in various routing scenarios, specifying exactly which vertices are used for access.
Also applies to: 15616-15616, 15628-15628, 15652-15652
NEWS.md (1)
1-1: 🧹 Nitpick (assertive)Nitpick: Include article and punctuation for clarity
Consider revising the sentence to read:
“To read the entire history of releases, go to the latest release notes.”
This adds the article “the” and a comma to improve flow.⛔ Skipped due to 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#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.🧰 Tools
🪛 LanguageTool
[uncategorized] ~1-~1: You might be missing the article “the” here.
Context: To read all history of releases go to the latest [release n...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~1-~1: Make sure the noun ‘history’ is in agreement with the verb ‘go’. Beware that some collective nouns (like ‘police’ or ‘team’) can be treated as both singular and plural.
Context: To read all history of releases go to the latest [release notes](https://d...(DT_NN_OF_NNS_VB)
🪛 markdownlint-cli2 (0.17.2)
1-1: First line in a file should be a top-level heading
null(MD041, first-line-heading, first-line-h1)
doc/src/release_notes.rst (1)
95-95: Approve C/C++ enhancements entry
This change correctly captures the code reorganization under C/C++ enhancements.locale/es/LC_MESSAGES/pgrouting_doc_strings.po (80)
13-13: Update looks goodThe POT-Creation-Date has been updated to reflect the current generation date of the translation file.
304-305: New translation added correctlyAppropriate Spanish translation for "Boost Graph inside" has been added.
1259-1260: Translation correctly added for summary row textThe translation for capacity violations summary row has been properly added.
1281-1282: Translation correctly added for time window violationsThe translation for time windows violations summary row has been properly added.
1729-1729: Minor formatting improvementAdded colon for consistency in the English text for the matrix length value example.
2075-2076: New translation added correctlyAdded Spanish translation for PostgreSQL version reference.
4302-4306: New translations for function categories added correctlyAdded Spanish translations for TRSP function and Utilities category heading.
4315-4318: Translation for pgr_findCloseEdges updated correctlyUpdated Spanish translation for the pgr_findCloseEdges function description.
4356-4382: 3.8.0 Release notes translations added correctlyThe Spanish translations for pgRouting 3.8.0 release notes, including GitHub links, function promotions, and error message adjustments, have been properly added.
4391-4404: Translation of function changes added correctlyThe Spanish translations for the function signature changes and removal of
partialoption have been properly added.
4406-4454: Translations for new proposed functions added correctlySpanish translations for new proposed functions and contraction functions have been properly added, though some are marked as fuzzy, indicating they may need further refinement.
4458-4493: Translation of function parameter changes added correctlyThe Spanish translations for parameter changes, including optional parameters and their new names, have been properly added.
4494-4548: Translations for deprecated functions added correctlyThe Spanish translations for deprecated functions section have been properly added, with appropriate references to the GitHub issues.
6567-6586: New translations for intersection fixing functionalityTranslations added for the intersection fixing section, though many are marked fuzzy, indicating they may need further refinement.
6589-6633: Translations for table preparation and topology updatingSpanish translations added for sections about preparing tables, adding segments, and updating topology.
6634-6677: Translations for touching edges functionalitySpanish translations added for the touching edges section, describing how to handle edges that visually appear connected but aren't internally.
6682-6698: Translations for network connectivitySpanish translations added for sections about connecting components and obtaining graph connectivity.
6701-6730: Translations for using separation functionsSpanish translations added for sections describing the use of pgr_separateCrossing and pgr_separateTouching functions.
7599-7603: Database upgrade instructions translation updatedUpdated translation for the instructions to upgrade to pgRouting 3.8.0.
8143-8144: Standardization note translation addedTranslation added for the note about standardizing output columns.
8400-8401: English source text improvedImproved clarity of the English text about solution guarantees in the worst case.
8410-8411: English source text improvedImproved clarity of the English text about solution guarantees for specific cases.
8422-8423: English source text improvedImproved clarity of the English text about solution guarantees for directed graphs.
8540-8541: Translation for asymmetric matrix usage addedAdded translation for using points of interest to generate an asymmetric matrix.
8553-8554: Translation for asymmetric matrix generation addedAdded translation for line 6 about generating an asymmetric matrix with directed flag.
8628-8633: English text corrected and translation updatedCorrected "than" to "that" in the English text about duplicate identifiers and updated the translation accordingly.
8711-8712: English source text improvedImproved the English text about visual results with link to the optimal solution.
8725-8726: Translation for standardized output columns addedAdded translation for standardizing output columns to short-generic-result.
8744-8745: Translation for combination signature addedAdded translation for pgr_aStar(Combinations) function signature.
8861-8869: Translation for combination cost function addedAdded translation for pgr_aStarCost(Combinations) function and improved English text about summarizing costs.
8931-8932: Translation for internal algorithm usage addedAdded translation for note about internally using the pgr_aStar algorithm.
9618-9619: Translation for combination signature addedAdded translation for pgr_bdAstar(Combinations) function signature.
9670-9674: Translation for combination cost function addedAdded translation for pgr_bdAstarCost(Combinations) function and improved English text about summarizing costs.
9714-9715: Translation for internal algorithm usage addedAdded translation for note about internally using the pgr_bdAstar algorithm.
9730-9731: Translation for combination signature addedAdded translation for pgr_bdDijkstra(Combinations) function signature.
9820-9824: Translation for combination cost function addedAdded translation for pgr_bdDijkstraCost(Combinations) function and improved English text about summarizing costs.
10022-10023: Translation correctly updated for "Boost Graph Inside"Updated translation to "Adentro: Boost Graph" for better clarity in Spanish.
10408-10409: Translation for combination signature addedAdded translation for pgr_boykovKolmogorov(Combinations) function signature.
12403-12404: Translation for combination signature addedAdded translation for pgr_dijkstra(Combinations) function signature.
12652-12657: Translation for combination cost function addedAdded translation for pgr_dijkstraCost(Combinations) function and improved English text about summarizing costs.
12874-12875: Translation for undirected graph usage addedAdded translation for using an undirected graph for pedestrian routing.
12983-12984: English text improved for equal cost pathsImproved the English text about equally good paths with the same cost.
13092-13093: Translation for equal cost paths addedAdded translation for both options being equally good due to same cost.
13210-13211: Translation for standardized output columns addedAdded translation for standardizing output columns to result-spantree format.
13238-13239: English text improved for spanning tree descriptionImproved the English text to clarify that extracted edges conform to the spanning tree.
13516-13517: Translation for combination signature addedAdded translation for pgr_edmondsKarp(Combinations) function signature.
14166-14167: English text improved for Hawick circuits descriptionImproved the English description of the Hawick circuits algorithm functionality.
14230-14233: Translation for path_seq description addedAdded translation for the description of the relative position in the path.
14344-14345: English text improved for Johnson algorithm complexityImproved the English text about the time complexity of the Johnson algorithm.
14509-14511: English text improved for dominator algorithm descriptionImproved the English text to better describe how the Lengauer Tarjan algorithm calculates dominators.
15014-15015: Translation for restriction identification addedAdded translation for "Identifying the restriction" section heading.
15023-15024: English text improved for edge alterationImproved the English text to clarify which edge needs to be altered based on the query.
15256-15257: Translation for combination signature addedAdded translation for pgr_maxFlow(Combinations) function signature.
15442-15450: Translations for nodeNetwork improvements addedAdded translations for notes about not checking indexes, using separation functions, and using BIGINT datatype.
15516-15520: Translations for empty columns addedAdded translations for empty source and target columns in the description.
15894-15895: Translation for combination signature addedAdded translation for pgr_pushRelabel(Combinations) function signature.
15915-15970: Translations for new separation functions addedAdded translations for pgr_separateCrossing and pgr_separateTouching functions, including descriptions and parameters. These appear to be new utility functions for handling edge geometry intersections and connections.
16301-16302: Translation for compressed graph note addedAdded translation for note about the returned graph being compressed.
16342-16343: Translation for proposed TRSP function addedAdded translation for pgr_trsp as a proposed function.
16366-16378: Translations for deprecated TRSP signatures addedAdded translations for deprecated signatures of TRSP functions, clearly indicating which function variants are being phased out.
16470-16471: Translation for proposed TRSP Via function addedAdded translation for pgr_trspVia as a proposed function.
16558-16559: Translation for proposed TRSP Via with Points function addedAdded translation for pgr_trspVia_withPoints as a proposed function.
16735-16736: Translation for proposed TRSP with Points function addedAdded translation for pgr_trsp_withPoints as a proposed function.
16977-16979: Translation for proposed withPoints function addedAdded translation for pgr_withPoints as a proposed function.
17154-17155: Translation for proposed withPoints Cost function addedAdded translation for pgr_withPointsCost as a proposed function.
17338-17339: Translation for proposed withPoints Cost Matrix function addedAdded translation for pgr_withPointsCostMatrix as a proposed function.
17378-17379: Translation for proposed withPoints Driving Distance function addedAdded translation for pgr_withPointsDD as a proposed function.
17552-17553: Translation for proposed withPoints KSP function addedAdded translation for pgr_withPointsKSP as a proposed function.
17733-17734: Translation for proposed withPoints Via function addedAdded translation for pgr_withPointsVia as a proposed function.
17852-17858: Translations for new separation functions documentation addedAdded translations for documentation references to pgr_separateCrossing and pgr_separateTouching functions.
18495-18499: Translations for TRSP function references addedAdded translations for references to pgr_trsp and pgr_trsp_withPoints functions.
20015-20016: Translation for withPoints Cost Matrix reference addedAdded translation for pgr_withPointsCostMatrix function reference.
20225-20226: Translation for withPoints KSP reference addedAdded translation for pgr_withPointsKSP function reference.
21088-21089: Translation for Utility functions heading addedAdded translation for the "Utility functions" section heading.
21283-21284: English text improved for sample data referenceImproved the English text about using sample data for examples with points of interest.
21377-21378: Translation for undirected graph usage addedAdded translation for preferred usage on undirected graphs.
21413-21414: Translation for vertex arrival information addedAdded translation for information about arrival to point -2 via vertex 16.
21430-21431: Translation for edge cost information addedAdded translation for information about edge (-2, 17) with cost 0.6.
21443-21444: Translation for vertex arrival information addedAdded translation for information about arrival to point -2 via vertex 17.
21473-21474: Translation for multiple vertex arrival information addedAdded translation for information about arrival to point -2 via multiple vertices.
locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (11)
14-14: Update to the POT creation dateThe POT creation date has been updated to April 22, 2025, reflecting when the translation template was generated.
296-297: New translation for "Boost Graph inside"New translation added for the Boost Graph library reference, correctly translated to "Boost 图内部".
1178-1179: New translation for capacity violations summaryAdded translation for the summary row description related to total capacity violations.
1197-1198: New translation for time windows violations summaryAdded translation for the summary row description related to total time windows violations.
1616-1616: English source string correctionMinor correction to the English source text about matrix length values.
1942-1943: New translation for PostgreSQL versionAdded translation for "PostgreSQL version 9.3".
4007-4020: Added translations for new functions and categoriesAdded translations for:
- The pgr_trsp function (Turn Restriction Shortest Path)
- The "Utilities" category header
- The pgr_findCloseEdges function (marked as fuzzy)
The pgr_findCloseEdges translation is marked fuzzy as it may need refinement, but the current translation is a reasonable starting point.
4147-4176: Official functions changes sectionAdded translations for changes to official functions, including new signatures and deprecated functions.
4177-4202: C/C++ code and SQL enhancements sectionsAdded translations for C/C++ and SQL code enhancement sections, with some entries marked as fuzzy.
15255-15293: Added translations for pgr_trsp function familyTranslations for the Turn Restriction Shortest Path (TRSP) functions and their deprecated signatures.
This properly documents the TRSP functions in the Chinese documentation, including both new and deprecated signatures.
15385-15388: Consistent translation of "Proposed" status for functionsAll functions with "Proposed" status are consistently translated with "拟议" suffix.
Also applies to: 15485-15488, 15677-15679, 15899-15901, 16058-16060, 16226-16228, 16263-16265, 16428-16430, 16591-16593
cvvergara
force-pushed
the
simplify-NEWS-3.8
branch
from
85d7e70 to
8b82377
Compare
cvvergara
force-pushed
the
simplify-NEWS-3.8
branch
from
8b82377 to
8b686c9
Compare
There was a problem hiding this comment.
Actionable comments posted: 24
♻️ Duplicate comments (19)
doc/categories/withPoints-category.rst (1)
267-267: Review duplicate introductory heading adjustment
The phraseIn the following images:aligns with the previous suggestion to clarify this intro.NEWS.md (7)
19-19: Wrap function name in backticks
For consistency and clarity, wrappgr_extractVerticesin backticks and include “function” in the description:- Promoted to official pgr_extractVertices in version 3.8 + Promoted to official function `pgr_extractVertices` in version 3.8
25-25: Wrap function name in backticks
Similarly, wrappgr_degreein backticks:- Promoted to official pgr_degree in version 3.8 + Promoted to official function `pgr_degree` in version 3.8
32-32: Wrap function name in backticks
And wrappgr_findCloseEdgesin backticks:- Promoted to official pgr_findCloseEdges in version 3.8 + Promoted to official function `pgr_findCloseEdges` in version 3.8
88-91: Clarify migration notes
The bullets are vague. Consider rephrasing, e.g.:- - Migration section is created. - - The use of the functions is removed in the documentation. + - A migration guide section has been added. + - References to deprecated functions have been removed from the documentation.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
90-90: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
91-91: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
77-85: 🧹 Nitpick (assertive)🛠️ Refactor suggestion
Separate C/C++ deprecations into their own section
Per documentation conventions, after listing SQL signature deprecations, add a new “Deprecation of C/C++ functions” heading to list underlying code deprecations separately. This aligns with past practice and retrieved learnings.Would you like help drafting the C/C++ deprecation rubric and entries?
47-52: 🧹 Nitpick (assertive)Consolidate and code-format “Utilities” entries
Apply the same pattern under Utilities: use two-space indents, wrap category in bold/backticks if desired, and combine issue and description. For example:- * [#2848](...): - Create pgr_separateCrossing new utility function + * [#2848](...) — `pgr_separateCrossing`: new utility function
42-46: 🧹 Nitpick (assertive)Consolidate and code-format “Proposed functions” entries
Refactor this block to use a consistent two-space indent, wrap function names in backticks, and combine issue and description on one line. For example:- * [#2790](...): - pgr_contractionDeadEnd new contraction function + * [#2790](...) — `pgr_contractionDeadEnd`: new contraction functiondoc/src/release_notes.rst (8)
49-49: Wrap function name in code markup
Use double backticks for the function name and include “function” in the sentence:- Promoted to official pgr_extractVertices in version 3.8 + Promoted to official function ``pgr_extractVertices`` in version 3.8
56-56: Wrap function name in code markup
Similarly forpgr_degree:- Promoted to official pgr_degree in version 3.8 + Promoted to official function ``pgr_degree`` in version 3.8
63-63: Wrap function name in code markup
And forpgr_findCloseEdges:- Promoted to official pgr_findCloseEdges in version 3.8 + Promoted to official function ``pgr_findCloseEdges`` in version 3.8
87-88: Wrap signature in code markup and combine lines
Merge the entry into one line and use code markup:- * `#2786`__: - pgr_contraction(edges) new signature + * `#2786`__ — ``pgr_contraction(edges)``: new signature
119-120: Clarify migration notes
Rephrase these dashes as asterisks and clarify text:- - Migration section is created. - - The use of the functions is removed in the documentation. + * A migration guide section has been added. + * References to deprecated functions have been removed from the documentation.
104-115: 🧹 Nitpick (assertive)🛠️ Refactor suggestion
Add “Deprecation of C/C++ functions” rubric
Following retrieved learnings, introduce a separate.. rubric:: Deprecation of C/C++ functionssection after the SQL deprecations to document underlying implementation formal deprecations.I can help craft the C/C++ entries if needed.
80-83: 🧹 Nitpick (assertive)Refactor “Utilities” list formatting
Same pattern for Utilities:- * `#2848`__: - Create pgr_separateCrossing new utility function + * `#2848`__ — ``pgr_separateCrossing``: new utility function
73-76: 🧹 Nitpick (assertive)Refactor “Proposed functions” list formatting
Combine issue and description on one line, wrap function names in double backticks, e.g.:- * `#2790`__: - pgr_contractionDeadEnd new contraction function + * `#2790`__ — ``pgr_contractionDeadEnd``: new contraction functionlocale/es/LC_MESSAGES/pgrouting_doc_strings.po (1)
14216-14220:⚠️ Potential issueIncorrect translation for circuit count
The translation for ":math:
|c|is the number of circuits in the graph" is incorrect. It's translated as "the number of vertices in the graph" instead of "the number of circuits in the graph".Apply this correction:
-msgstr ":math:`|c|` es la cantidad de vertices del grafo." +msgstr ":math:`|c|` es la cantidad de circuitos del grafo."locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (2)
4061-4069: 🛠️ Refactor suggestionMilestone link and version string not updated
msgidpoints to the 3.8.0 milestone, butmsgstrstill hard‑codes 3.7.0.
Update URL and visible version to 3.8.0, then drop the#, fuzzyflag.-"查看本版本已关闭的所有议题和拉取请求，请访问：`GitHub 3.7.0版本里程碑关闭列" +"查看本版本已关闭的所有议题和拉取请求，请访问：`GitHub 3.8.0 版本里程碑关闭列"
4083-4094:⚠️ Potential issueMissing translation for “Error messages adjustment.”
msgstris empty – please supply a concise Chinese translation, e.g.:-msgstr "" +msgstr "错误消息调整。"After adding, delete the
#, fuzzymarker.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (10)
NEWS.md(40 hunks)doc/categories/withPoints-category.rst(8 hunks)doc/conf.py.in(1 hunks)doc/src/release_notes.rst(2 hunks)doc/tsp/pgr_TSP.rst(3 hunks)doc/tsp/pgr_TSPeuclidean.rst(3 hunks)locale/en/LC_MESSAGES/pgrouting_doc_strings.po(46 hunks)locale/es/LC_MESSAGES/pgrouting_doc_strings.po(75 hunks)locale/pot/pgrouting_doc_strings.pot(44 hunks)locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po(76 hunks)
👮 Files not reviewed due to content moderation or server errors (1)
- locale/en/LC_MESSAGES/pgrouting_doc_strings.po
🧰 Additional context used
🧠 Learnings (6)
📓 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.
doc/src/release_notes.rst (3)
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#2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
Learnt from: cvvergara
PR: pgRouting/pgrouting#0
File: :0-0
Timestamp: 2025-01-27T01:49:25.212Z
Learning: In pgRouting, when deprecating internal functions:
1. Add deprecation notice in C code using ereport with ERRCODE_FEATURE_NOT_SUPPORTED
2. Update tests with version checks (min_version, min_lib_version)
3. Document changes in NEWS.md under appropriate sections
NEWS.md (5)
Learnt from: cvvergara
PR: pgRouting/pgrouting#2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
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.
Learnt from: cvvergara
PR: pgRouting/pgrouting#0
File: :0-0
Timestamp: 2025-01-27T01:49:25.212Z
Learning: In pgRouting, when deprecating internal functions:
1. Add deprecation notice in C code using ereport with ERRCODE_FEATURE_NOT_SUPPORTED
2. Update tests with version checks (min_version, min_lib_version)
3. Document changes in NEWS.md under appropriate sections
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.
locale/en/LC_MESSAGES/pgrouting_doc_strings.po (6)
undefined
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (2)
undefined
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
locale/pot/pgrouting_doc_strings.pot (3)
undefined
<retrieved_learning>
Learnt from: cvvergara
PR: #2725
File: src/dijkstra/dijkstra_driver.cpp:147-148
Timestamp: 2025-01-19T16:18:55.529Z
Learning: In pgRouting, error messages should not be modified without careful consideration as they are verified by pgtap tests. Changes to error messages require corresponding updates to test cases.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #2744
File: NEWS.md:63-63
Timestamp: 2025-02-06T20:50:00.577Z
Learning: In pgRouting's NEWS.md, the "Removal of SQL deprecated internal functions" section lists SQL signatures being removed, while "Deprecation of internal C/C++ functions" section lists the underlying C/C++ implementations being deprecated. A function can appear in both sections when its SQL signature is removed while its C/C++ implementation is deprecated.
</retrieved_learning>
<retrieved_learning>
Learnt from: cvvergara
PR: #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:
- SQL level - removal/addition of function signatures
- C/C++ level - deprecation/changes to the underlying implementation
These are documented separately in the release notes.
</retrieved_learning>
🪛 LanguageTool
NEWS.md
[uncategorized] ~1-~1: You might be missing the article “the” here.
Context: To read all history of releases go to the latest [release n...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~1-~1: Make sure the noun ‘history’ is in agreement with the verb ‘go’. Beware that some collective nouns (like ‘police’ or ‘team’) can be treated as both singular and plural.
Context: To read all history of releases go to the latest [release notes](https://d...
(DT_NN_OF_NNS_VB)
🪛 markdownlint-cli2 (0.17.2)
NEWS.md
1-1: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
38-38: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
54-54: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
70-70: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
75-75: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
90-90: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
91-91: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
95-95: Inline HTML
Element: details
(MD033, no-inline-html)
95-95: Inline HTML
Element: summary
(MD033, no-inline-html)
98-98: Spaces inside link text
null
(MD039, no-space-in-links)
105-105: Inline HTML
Element: details
(MD033, no-inline-html)
105-105: Inline HTML
Element: summary
(MD033, no-inline-html)
128-128: Inline HTML
Element: details
(MD033, no-inline-html)
128-128: Inline HTML
Element: summary
(MD033, no-inline-html)
147-147: Inline HTML
Element: details
(MD033, no-inline-html)
147-147: Inline HTML
Element: summary
(MD033, no-inline-html)
207-207: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
208-208: Inline HTML
Element: details
(MD033, no-inline-html)
208-208: Inline HTML
Element: summary
(MD033, no-inline-html)
248-248: Inline HTML
Element: details
(MD033, no-inline-html)
248-248: Inline HTML
Element: summary
(MD033, no-inline-html)
270-270: Inline HTML
Element: details
(MD033, no-inline-html)
270-270: Inline HTML
Element: summary
(MD033, no-inline-html)
281-281: Inline HTML
Element: details
(MD033, no-inline-html)
281-281: Inline HTML
Element: summary
(MD033, no-inline-html)
399-399: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
400-400: Inline HTML
Element: details
(MD033, no-inline-html)
400-400: Inline HTML
Element: summary
(MD033, no-inline-html)
443-443: Inline HTML
Element: details
(MD033, no-inline-html)
443-443: Inline HTML
Element: summary
(MD033, no-inline-html)
463-463: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
464-464: Inline HTML
Element: details
(MD033, no-inline-html)
464-464: Inline HTML
Element: summary
(MD033, no-inline-html)
479-479: Inline HTML
Element: details
(MD033, no-inline-html)
479-479: Inline HTML
Element: summary
(MD033, no-inline-html)
494-494: Inline HTML
Element: details
(MD033, no-inline-html)
494-494: Inline HTML
Element: summary
(MD033, no-inline-html)
574-574: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
575-575: Inline HTML
Element: details
(MD033, no-inline-html)
575-575: Inline HTML
Element: summary
(MD033, no-inline-html)
582-582: Inline HTML
Element: details
(MD033, no-inline-html)
582-582: Inline HTML
Element: summary
(MD033, no-inline-html)
595-595: Inline HTML
Element: details
(MD033, no-inline-html)
595-595: Inline HTML
Element: summary
(MD033, no-inline-html)
618-618: Inline HTML
Element: details
(MD033, no-inline-html)
618-618: Inline HTML
Element: summary
(MD033, no-inline-html)
656-656: Inline HTML
Element: details
(MD033, no-inline-html)
656-656: Inline HTML
Element: summary
(MD033, no-inline-html)
671-671: Inline HTML
Element: details
(MD033, no-inline-html)
671-671: Inline HTML
Element: summary
(MD033, no-inline-html)
727-727: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
728-728: Inline HTML
Element: details
(MD033, no-inline-html)
728-728: Inline HTML
Element: summary
(MD033, no-inline-html)
742-742: Inline HTML
Element: details
(MD033, no-inline-html)
742-742: Inline HTML
Element: summary
(MD033, no-inline-html)
760-760: Inline HTML
Element: details
(MD033, no-inline-html)
760-760: Inline HTML
Element: summary
(MD033, no-inline-html)
840-840: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
841-841: Inline HTML
Element: details
(MD033, no-inline-html)
841-841: Inline HTML
Element: summary
(MD033, no-inline-html)
856-856: Inline HTML
Element: details
(MD033, no-inline-html)
856-856: Inline HTML
Element: summary
(MD033, no-inline-html)
875-875: Inline HTML
Element: details
(MD033, no-inline-html)
875-875: Inline HTML
Element: summary
(MD033, no-inline-html)
898-898: Inline HTML
Element: details
(MD033, no-inline-html)
898-898: Inline HTML
Element: summary
(MD033, no-inline-html)
922-922: Inline HTML
Element: details
(MD033, no-inline-html)
922-922: Inline HTML
Element: summary
(MD033, no-inline-html)
942-942: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
943-943: Inline HTML
Element: details
(MD033, no-inline-html)
943-943: Inline HTML
Element: summary
(MD033, no-inline-html)
958-958: Inline HTML
Element: details
(MD033, no-inline-html)
958-958: Inline HTML
Element: summary
(MD033, no-inline-html)
977-977: Inline HTML
Element: details
(MD033, no-inline-html)
977-977: Inline HTML
Element: summary
(MD033, no-inline-html)
1001-1001: Inline HTML
Element: details
(MD033, no-inline-html)
1001-1001: Inline HTML
Element: summary
(MD033, no-inline-html)
1020-1020: Inline HTML
Element: details
(MD033, no-inline-html)
1020-1020: Inline HTML
Element: summary
(MD033, no-inline-html)
1035-1035: Inline HTML
Element: details
(MD033, no-inline-html)
1035-1035: Inline HTML
Element: summary
(MD033, no-inline-html)
1050-1050: Inline HTML
Element: details
(MD033, no-inline-html)
1050-1050: Inline HTML
Element: summary
(MD033, no-inline-html)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (16)
doc/tsp/pgr_TSP.rst (5)
70-71: Correctly stated 2‑approximation guarantee
The phrasing clearly conveys that, in the worst case, the solution produced is at most twice the length of the optimal tour.
75-78: Clarify exception when fixingend_vid
This note accurately explains that forcing a fixed end vertex invalidates the standard worst‑case bound.
81-83: Consistent clarification for directed graphs
The added bullet correctly warns that withdirected => true, the 2‑approximation guarantee no longer holds.
190-191: Example title for asymmetric matrix generation
The new section header clearly introduces the “points of interest” asymmetric-matrix example.
197-198: Explicit example fordirected => true
This bullet correctly highlights that directed graphs may violate the 2‑approximation bound.doc/tsp/pgr_TSPeuclidean.rst (1)
85-87: Spelling corrected for “EMPTY SET”
The summary now correctly uses “EMPTY SET,” fixing the previous typo.locale/pot/pgrouting_doc_strings.pot (9)
11-11: Minor update to POT creation date.This is a routine update to the POT file creation timestamp.
1039-1039: Correctly formatted documentation string.The formatting with boldface for "total capacity violations" properly emphasizes the key term in the documentation.
1054-1054: Properly formatted documentation string.The formatting with boldface for "total time windows violations" appropriately highlights this important term.
2772-2774: Documentation update for promoted function pgr_degree.The documentation string is correctly updated to reflect the promotion of pgr_degree to official status in version 3.8, which aligns with the PR objectives.
2786-2789: Documentation update for pgr_contraction function signature changes.The updates clearly document the changes made to the pgr_contraction function, noting that the previously compulsory parameter is now optional and has been renamed. This is important information for users migrating to the new version.
2850-2850: Documentation update about rewriting pgr_nodeNetwork.This entry correctly documents the rewrite of pgr_nodeNetwork function, which is relevant for users of this function.
2853-2857: Documentation of deprecated SQL functions.These entries properly document the deprecation of SQL functions in version 3.8, which aligns with the PR objectives. This information is crucial for users to understand which functions they should stop using and what alternatives are available.
3529-3566: Documentation for deprecated functions in version 3.8.This section comprehensively documents the functions deprecated in version 3.8, providing users with the information they need to update their code. The consistent format and clear enumeration of the deprecated functions makes this information easy to understand.
3598-3623: Documentation of in-the-deprecated-functions statements.This section properly documents what has been done with the deprecated functions, including the creation of migration sections and removal of function usage from documentation. This helps users understand how to migrate away from these functions.
locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (1)
4161-4166: 🧹 Nitpick (assertive)Grammar & terminology in new‑signature note
Current translation mixes English terms and mistranslates “Contraction order”.
Suggested:-"之前必需的参数 **Contraction order** 现在已变为可选参数，并更名为 ``methods``。" +"原先必需的 **Contraction order** 参数现在变为可选，并命名为 ``methods``。"Likely an incorrect or invalid review comment.
cvvergara
force-pushed
the
simplify-NEWS-3.8
branch
from
72fd3b1 to
6166f3b
Compare
There was a problem hiding this comment.
Actionable comments posted: 8
♻️ Duplicate comments (6)
locale/es/LC_MESSAGES/pgrouting_doc_strings.po (6)
304-305: Translation "Adentro Boost Graph" still needs improvement.The translation "Adentro Boost Graph" for "Boost Graph inside" remains awkward in Spanish. A more natural translation would be "Usando Boost Graph internamente" or "Con Boost Graph por dentro."
4499-4548: Incomplete translations for deprecation notices.The deprecation notices for several functions are still marked as fuzzy with inconsistent or missing translations. This makes it difficult for Spanish-speaking users to understand which functions are being deprecated and why.
For instance, pgr_AlphaShape references pgr_analyzeOneWay instead, and similar inconsistencies exist for other deprecated functions.
6573-6677: Missing translations for example usage sections persist.Many example sections for the new utility functions remain untranslated, including:
- "In this example..."
- "An example use without results"
- "Routing from X to Y gives..."
These examples are important for users to understand how to use these new functions.
8411-8416: Missing translations for non-guaranteed solution text.The sections about solution guarantees remain marked as fuzzy and still lack Spanish translations:
+msgstr "Las soluciones generadas **no están garantizadas** para ser, en el peor de los casos, el doble de largas que el recorrido óptimo, debido al hecho de que `end_vid` está obligado a estar en una posición fija."And similarly for the second instance.
Also applies to: 8424-8428
17894-17929: Inconsistent translations for function promotions in the summary section.The function promotion listings in the pgRouting 3.8 section remain marked as fuzzy and inconsistent with the more detailed translations earlier in the document.
Ensure translations use consistent terminology and are complete for all promoted functions.
16980-16982: Multiple proposed functions still marked as fuzzy.Several proposed functions (pgr_withPoints, pgr_trsp, etc.) continue to be marked as fuzzy, indicating the translations need review due to changes in the source text.
Review all fuzzy translations to ensure they accurately reflect the current English text.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
locale/es/LC_MESSAGES/pgrouting_doc_strings.po(75 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: cvvergara
PR: pgRouting/pgrouting#2864
File: NEWS.md:56-57
Timestamp: 2025-04-22T22:41:25.271Z
Learning: In pgRouting, NEWS.md is an automatically generated file that should not be modified manually. Changes to the NEWS.md content should be made by modifying the generator script (tools/release-scripts/notes2news.pl) or its source files.
Learnt from: cvvergara
PR: pgRouting/pgrouting#2864
File: NEWS.md:47-50
Timestamp: 2025-04-22T22:41:34.698Z
Learning: In pgRouting, NEWS.md is a generated file created by the tools/release-scripts/notes2news.pl script and should not be modified manually.
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.
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: documentation (zh_Hans)
- GitHub Check: documentation (es)
🔇 Additional comments (3)
locale/es/LC_MESSAGES/pgrouting_doc_strings.po (3)
4302-4318: Good translations for TRSP and utility functions!The translations for TRSP (Turn Restriction Shortest Path) and pgr_findCloseEdges are clear and accurate.
14219-14220: Great correction of the circuit translation!The translation for ":math:
|c|is the number of circuits in the graph" has been correctly updated to refer to "circuitos" (circuits) instead of "vertices" (vertices).
17370-17372: Fixed duplicate "the" in translation.The English text "In the the following images" has been corrected to "In the following images" and properly translated to "En las siguientes imágenes".
Fixes #2863
Changes proposed in this pull request:
@pgRouting/admins
Summary by CodeRabbit