Skip to content

Conversation

@cvvergara
Copy link
Member

@cvvergara cvvergara commented Oct 10, 2025

Changes proposed in this pull request:

  • Fixes documentation problems with experimental, proposed and official functions

@pgRouting/admins

Summary by CodeRabbit

  • New Features
    • Promoted pgr_dijkstraNear, pgr_dijkstraNearCost, and pgr_dijkstraVia to official.
  • Breaking Changes
    • Removed legacy signatures for pgr_TSP, pgr_TSPeuclidean, and pgr_maxCardinalityMatch.
    • Removed experimental pgr_sloanOrdering.
  • Documentation
    • Reorganized Dijkstra, Ordering, and Experimental sections; added traversal categories.
    • Updated release notes and extensive localization (DE/JA/KO/ZH).
  • Chores
    • Bumped version to 4.0.0-beta1.
    • Workflow updates (install gettext, narrowed query checks) and test data setup improvements.

cvvergara and others added 30 commits September 14, 2025 12:36
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5 to 6.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v5...v6)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Currently translated at 83.1% (4466 of 5374 strings)

Translated using Weblate (Swedish)

Currently translated at 92.8% (4985 of 5367 strings)

Translated using Weblate (Swedish)

Currently translated at 94.3% (5327 of 5645 strings)

Co-authored-by: Celia Virginia Vergara Castillo <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/sv/
Translation: pgRouting/pgRouting
Updated by "Update PO files to match POT (msgmerge)" hook in Weblate.

Update translation files

Updated by "Update PO files to match POT (msgmerge)" hook in Weblate.

Co-authored-by: Weblate <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/
Translation: pgRouting/pgRouting
All functions with prefix pgr_dijkstra are official
Currently translated at 0.0% (0 of 5374 strings)

Translated using Weblate (Korean)

Currently translated at 2.8% (151 of 5374 strings)

Translated using Weblate (Japanese)

Currently translated at 2.4% (131 of 5374 strings)

Translated using Weblate (Spanish)

Currently translated at 83.1% (4466 of 5374 strings)

Co-authored-by: Anonymous <[email protected]>
Co-authored-by: Weblate <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/de/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/ja/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/ko/
Translation: pgRouting/pgRouting
Currently translated at 2.4% (131 of 5374 strings)

Translated using Weblate (Spanish)

Currently translated at 83.1% (4466 of 5374 strings)

Co-authored-by: Celia Virginia Vergara Castillo <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/ja/
Translation: pgRouting/pgRouting
Currently translated at 83.1% (4466 of 5374 strings)

Co-authored-by: DeepL <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Translation: pgRouting/pgRouting
Currently translated at 83.1% (4466 of 5374 strings)

Co-authored-by: Pedro Jose Rios Vergara <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Translation: pgRouting/pgRouting
Currently translated at 2.8% (151 of 5374 strings)

Co-authored-by: Hyung-Gyu Ryoo <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/ko/
Translation: pgRouting/pgRouting
Currently translated at 86.3% (4643 of 5374 strings)

Co-authored-by: Zuochenwei <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/zh_Hans/
Translation: pgRouting/pgRouting
Updated by "Update PO files to match POT (msgmerge)" hook in Weblate.

Translated using Weblate (Swedish)

Currently translated at 92.2% (4960 of 5374 strings)

Translated using Weblate (Chinese (Simplified))

Currently translated at 86.3% (4643 of 5374 strings)

Co-authored-by: Anonymous <[email protected]>
Co-authored-by: Weblate <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/sv/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/zh_Hans/
Translation: pgRouting/pgRouting
Currently translated at 86.3% (4643 of 5374 strings)

Co-authored-by: Wangdapeng <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/zh_Hans/
Translation: pgRouting/pgRouting
Currently translated at 85.1% (4578 of 5375 strings)

Translated using Weblate (Chinese (Simplified))

Currently translated at 86.3% (4643 of 5374 strings)

Co-authored-by: DeepL <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/zh_Hans/
Translation: pgRouting/pgRouting
Currently translated at 86.3% (4643 of 5374 strings)

Co-authored-by: Celia Virginia Vergara Castillo <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/zh_Hans/
Translation: pgRouting/pgRouting
Daniel Nylander and others added 10 commits October 10, 2025 17:19
Currently translated at 92.2% (4960 of 5374 strings)

Co-authored-by: Daniel Nylander <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/sv/
Translation: pgRouting/pgRouting
Currently translated at 85.1% (4578 of 5375 strings)

Translated using Weblate (Swedish)

Currently translated at 92.2% (4960 of 5374 strings)

Co-authored-by: Celia Virginia Vergara Castillo <[email protected]>
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/sv/
Translation: pgRouting/pgRouting
Currently translated at 85.3% (4585 of 5375 strings)

Translation: pgRouting/pgRouting
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Currently translated at 85.3% (4585 of 5375 strings)

Translation: pgRouting/pgRouting
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Currently translated at 85.3% (4586 of 5375 strings)

Translation: pgRouting/pgRouting
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Currently translated at 85.3% (4586 of 5375 strings)

Translation: pgRouting/pgRouting
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/es/
Updated by "Update PO files to match POT (msgmerge)" hook in Weblate.

Translation: pgRouting/pgRouting
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/
Currently translated at 91.6% (4932 of 5379 strings)

Translation: pgRouting/pgRouting
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/sv/
Currently translated at 91.6% (4932 of 5379 strings)

Translation: pgRouting/pgRouting
Translate-URL: https://weblate.osgeo.org/projects/pgrouting/pgrouting-develop/sv/
…g-develop

Translations update from OSGeo Weblate
@cvvergara cvvergara added this to the Release 4.0.0 milestone Oct 10, 2025
@cvvergara cvvergara requested a review from robe2 October 10, 2025 21:48
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 10, 2025

Walkthrough

Broad documentation, localization, and CI updates: promote Dijkstra and TSP-related docs to official, reclassify experimental/proposed sections, update locales, adjust CI/workflows and test data, bump project version to 4.0.0-beta1, tweak shell script parameter handling, add gettext to workflow, and minor header include addition.

Changes

Cohort / File(s) Summary
CI and automation
.github/scripts/update_locale.sh, .github/workflows/check-queries.yml, .github/workflows/update-locale.yml, ci/winnie/build_pgrouting.sh, tools/testers/doc_queries_generator.pl
Switch sh -c param from $f to $1; limit TESTDIRS to mincut; add gettext to apt install; remove default GCC_TYPE fallback; load lc101.pg during data setup and per-test setup.
Versioning and release notes
CMakeLists.txt, NEWS.md, doc/src/release_notes.rst, docqueries/version/full_version.result, docqueries/version/version.result
Change version suffix -alpha1 to -beta1; add/promote entries (pgr_dijkstraNear/Cost/Via, TSP changes, removals); update release notes; update displayed version outputs.
Docs structure/categories
doc/dijkstra/dijkstra-family.rst, doc/bdAstar/bdAstar-family.rst, doc/bdDijkstra/bdDijkstra-family.rst, doc/categories/cost-category.rst, doc/chinese/chinesePostmanProblem-family.rst, doc/coloring/coloring-family.rst, doc/ordering/ordering-family.rst, doc/src/experimental.rst, doc/src/proposed.rst, doc/traversal/traversal-family.rst
Replace/adjust doc roles (e.g., :doc:), move items between official/experimental, unify Dijkstra toctree, move cost-category entries, reorganize Chinese Postman and traversal categories, update family markers.
Dijkstra function docs
doc/dijkstra/pgr_dijkstraNear.rst, doc/dijkstra/pgr_dijkstraNearCost.rst, doc/dijkstra/pgr_dijkstraVia.rst
Remove “Proposed” labeling; update availability to 4.0.0 where applicable; revise descriptions/signature labels; add promotion notes.
Ordering and related docs
doc/ordering/pgr_cuthillMckeeOrdering.rst, doc/ordering/pgr_kingOrdering.rst, doc/ordering/pgr_sloanOrdering.rst, doc/ordering/pgr_topologicalSort.rst, doc/max_flow/pgr_edgeDisjointPaths.rst
Mark ordering pages as Experimental; adjust signatures/index entries; note promotion of Combinations for edgeDisjointPaths.
Localization updates
locale/de/LC_MESSAGES/pgrouting_doc_strings.po, locale/ja/LC_MESSAGES/pgrouting_doc_strings.po, locale/ko/LC_MESSAGES/pgrouting_doc_strings.po, locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po, locale/pot/pgrouting_doc_strings.pot
Widespread string updates, promotions/renames reflected, metadata bumps, added/fuzzy entries, standardized terminology and cross-references.
SQL comments (docs only)
sql/dijkstra/dijkstraNear.sql, sql/dijkstra/dijkstraNearCost.sql, sql/dijkstra/dijkstraVia.sql
Remove “PROPOSED” markers; refine parameter descriptions (arrays/combinations); minor comment pruning; no signature changes.
Docqueries cleanup
docqueries/pickDeliver/oneDepotWrapper.pg, docqueries/pickDeliver/oneDepotWrapper.result, docqueries/pickDeliver/test.conf
Remove VRP one-depot wrapper and expected results; simplify test config by removing nottesting group and a commented external path.
Header includes
include/drivers/ordering_driver.hpp
Add include to support fixed-width integer types usage in the header.

Sequence Diagram(s)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested labels

Documentation, Administrative

Suggested reviewers

  • robe2
  • iosefa

Poem

I thump my paw: beta blooms today,
Paths near and via hop into play.
Docs reburrow, flags rearranged,
Locales sprout clover—terms exchanged.
Scripts nibble params, neat and slight—
Onward I scamper, reviews in sight. 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title clearly and concisely indicates the primary change in this pull request, namely updating the project to version 4.0.0-beta1, which aligns with the version bump in CMakeLists and related documentation results. It is specific enough for team members to understand the main change at a glance and does not include unnecessary noise.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch develop

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 6

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
locale/ja/LC_MESSAGES/pgrouting_doc_strings.po (1)

218-221: Update Japanese column list to match new result schema

msgid now documents the result tuple as (seq, depth, start_vid, node, edge, cost, agg_cost) but the Japanese msgstr still says only (seq, node, cost, agg_cost). That leaves the localized docs incorrect. Please refresh the translation (or temporarily drop it) so it reflects the full column set.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 91edd82 and cedb39a.

📒 Files selected for processing (40)
  • .github/scripts/update_locale.sh (1 hunks)
  • .github/workflows/check-queries.yml (1 hunks)
  • .github/workflows/update-locale.yml (1 hunks)
  • CMakeLists.txt (1 hunks)
  • NEWS.md (6 hunks)
  • ci/winnie/build_pgrouting.sh (0 hunks)
  • doc/bdAstar/bdAstar-family.rst (1 hunks)
  • doc/bdDijkstra/bdDijkstra-family.rst (1 hunks)
  • doc/categories/cost-category.rst (1 hunks)
  • doc/chinese/chinesePostmanProblem-family.rst (1 hunks)
  • doc/coloring/coloring-family.rst (1 hunks)
  • doc/dijkstra/dijkstra-family.rst (1 hunks)
  • doc/dijkstra/pgr_dijkstraNear.rst (5 hunks)
  • doc/dijkstra/pgr_dijkstraNearCost.rst (5 hunks)
  • doc/dijkstra/pgr_dijkstraVia.rst (2 hunks)
  • doc/max_flow/pgr_edgeDisjointPaths.rst (2 hunks)
  • doc/ordering/ordering-family.rst (1 hunks)
  • doc/ordering/pgr_cuthillMckeeOrdering.rst (1 hunks)
  • doc/ordering/pgr_kingOrdering.rst (1 hunks)
  • doc/ordering/pgr_sloanOrdering.rst (1 hunks)
  • doc/ordering/pgr_topologicalSort.rst (1 hunks)
  • doc/src/experimental.rst (2 hunks)
  • doc/src/proposed.rst (0 hunks)
  • doc/src/release_notes.rst (6 hunks)
  • doc/traversal/traversal-family.rst (1 hunks)
  • docqueries/pickDeliver/oneDepotWrapper.pg (0 hunks)
  • docqueries/pickDeliver/oneDepotWrapper.result (0 hunks)
  • docqueries/pickDeliver/test.conf (0 hunks)
  • docqueries/version/full_version.result (1 hunks)
  • docqueries/version/version.result (1 hunks)
  • include/drivers/ordering_driver.hpp (1 hunks)
  • locale/de/LC_MESSAGES/pgrouting_doc_strings.po (68 hunks)
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po (68 hunks)
  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po (69 hunks)
  • locale/pot/pgrouting_doc_strings.pot (10 hunks)
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po (78 hunks)
  • sql/dijkstra/dijkstraNear.sql (0 hunks)
  • sql/dijkstra/dijkstraNearCost.sql (0 hunks)
  • sql/dijkstra/dijkstraVia.sql (0 hunks)
  • tools/testers/doc_queries_generator.pl (2 hunks)
💤 Files with no reviewable changes (8)
  • sql/dijkstra/dijkstraNear.sql
  • docqueries/pickDeliver/test.conf
  • doc/src/proposed.rst
  • ci/winnie/build_pgrouting.sh
  • docqueries/pickDeliver/oneDepotWrapper.result
  • docqueries/pickDeliver/oneDepotWrapper.pg
  • sql/dijkstra/dijkstraNearCost.sql
  • sql/dijkstra/dijkstraVia.sql
👮 Files not reviewed due to content moderation or server errors (1)
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
🧰 Additional context used
🧠 Learnings (20)
📚 Learning: 2025-09-14T16:56:27.138Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2970
File: .github/workflows/clang.yml:82-85
Timestamp: 2025-09-14T16:56:27.138Z
Learning: In pgRouting workflows, the PGDG testing suite (pgdg-testing) is used in testing workflows like clang.yml and ubuntu.yml to access more PostgreSQL versions including betas and development versions, while other workflows use the stable pgdg suite.

Applied to files:

  • .github/workflows/check-queries.yml
📚 Learning: 2025-09-14T16:43:16.715Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2970
File: .github/workflows/boost_version.yml:134-135
Timestamp: 2025-09-14T16:43:16.715Z
Learning: In pgrouting, the installed PostgreSQL extension version is normalized to major.minor.patch format (e.g., "4.0.0") regardless of any pre-release suffixes like -alpha1, -beta, or -rc that are used in the source/build versioning. Database setup scripts should use the normalized version format.

Applied to files:

  • docqueries/version/version.result
  • CMakeLists.txt
  • docqueries/version/full_version.result
📚 Learning: 2025-09-14T17:22:22.313Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2970
File: .github/workflows/update.yml:132-133
Timestamp: 2025-09-14T17:22:22.313Z
Learning: In pgRouting, when testing extension updates in workflows, the target version should be the normalized major.minor.patch format (e.g., "4.0.0") even for pre-release versions like 4.0.0-alpha1, because the extension is installed with the normalized version number regardless of source version suffixes.

Applied to files:

  • docqueries/version/version.result
  • docqueries/version/full_version.result
📚 Learning: 2025-02-06T20:50:07.967Z
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.

Applied to files:

  • doc/src/release_notes.rst
  • NEWS.md
  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/pot/pgrouting_doc_strings.pot
  • locale/de/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-02-27T23:08:14.497Z
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.

Applied to files:

  • doc/src/release_notes.rst
  • doc/dijkstra/pgr_dijkstraVia.rst
  • NEWS.md
  • locale/pot/pgrouting_doc_strings.pot
📚 Learning: 2025-02-06T20:50:00.577Z
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.

Applied to files:

  • NEWS.md
  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/pot/pgrouting_doc_strings.pot
  • locale/de/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-04-22T22:41:25.296Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2864
File: NEWS.md:56-57
Timestamp: 2025-04-22T22:41:25.296Z
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.

Applied to files:

  • NEWS.md
📚 Learning: 2025-04-22T22:36:50.711Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2864
File: locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po:4083-4087
Timestamp: 2025-04-22T22:36:50.711Z
Learning: For the `locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po` file, Chinese translations should be managed and updated via Weblate, not by direct manual edits or suggestions in the repository.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-04-22T22:59:10.377Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2864
File: locale/es/LC_MESSAGES/pgrouting_doc_strings.po:15446-15454
Timestamp: 2025-04-22T22:59:10.377Z
Learning: En pgRouting, las traducciones al español de las cadenas de documentación (por ejemplo, en `pgrouting_doc_strings.po`) se gestionan a través de Weblate y no se deben sugerir ni modificar directamente en los pull requests.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/pot/pgrouting_doc_strings.pot
  • locale/de/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-02-27T16:31:49.972Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2764
File: locale/en/LC_MESSAGES/pgrouting_doc_strings.po:2740-2740
Timestamp: 2025-02-27T16:31:49.972Z
Learning: Modifications to locale files in pgRouting (like .po files) are done through action commits or in weblate, not through direct manual edits in PRs.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-04-22T22:36:51.343Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2864
File: locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po:14862-14915
Timestamp: 2025-04-22T22:36:51.343Z
Learning: Chinese translations for pgRouting documentation are expected to be provided via Weblate, not through manual PR edits.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-02-27T23:03:08.160Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2771
File: locale/en/LC_MESSAGES/pgrouting_doc_strings.po:4407-4419
Timestamp: 2025-02-27T23:03:08.160Z
Learning: In the pgRouting project, locale files (.po files) should not be manually edited as they are managed through automated localization tools.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/pot/pgrouting_doc_strings.pot
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-02-27T16:32:00.573Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2764
File: locale/en/LC_MESSAGES/pgrouting_doc_strings.po:0-0
Timestamp: 2025-02-27T16:32:00.573Z
Learning: Modifications to locale files in the pgRouting project should be handled through an action commit or through the Weblate translation platform, not via direct edits.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-04-25T15:12:03.608Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2874
File: doc/utilities/pgr_separateCrossing.rst:26-27
Timestamp: 2025-04-25T15:12:03.608Z
Learning: In pgRouting documentation, official functions don't include version information in their index entries (`:single:` directives). Only deprecated functions include when they were deprecated in the index entries.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/de/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-01-19T16:18:55.529Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#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.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/de/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-01-19T16:19:16.974Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2725
File: src/trsp/trspVia_withPoints_driver.cpp:154-154
Timestamp: 2025-01-19T16:19:16.974Z
Learning: Error messages in pgRouting should be kept minimal and consistent to maintain compatibility with pgtap tests.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/de/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-01-19T16:17:53.496Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2725
File: src/coloring/edgeColoring_driver.cpp:87-87
Timestamp: 2025-01-19T16:17:53.496Z
Learning: Changes to error message handling in pgRouting functions require corresponding updates to pgtap tests to maintain test coverage.

Applied to files:

  • locale/ko/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/ja/LC_MESSAGES/pgrouting_doc_strings.po
  • locale/de/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-02-27T17:46:44.613Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2767
File: doc/_static/page_history.js:320-320
Timestamp: 2025-02-27T17:46:44.613Z
Learning: In the pgRouting documentation system, the check for Chinese Simplified language uses "zh-Hans" (with hyphen) format, but the actual directory name is "zh_Hans" (with underscore). The code in page_history.js correctly maps between these two formats.

Applied to files:

  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-04-24T23:36:04.580Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2868
File: include/drivers/contraction/contractionHierarchies_driver.h:1-73
Timestamp: 2025-04-24T23:36:04.580Z
Learning: The copyright year for pgRouting should be set to 2025 in new files, not 2024, as confirmed by the project maintainer.

Applied to files:

  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
📚 Learning: 2025-02-27T16:34:57.518Z
Learnt from: cvvergara
PR: pgRouting/pgrouting#2764
File: sql/sigs/pgrouting--3.8.sig:274-275
Timestamp: 2025-02-27T16:34:57.518Z
Learning: The file `sql/sigs/pgrouting--3.8.sig` is auto-generated by a command and should not be modified manually.

Applied to files:

  • locale/zh_Hans/LC_MESSAGES/pgrouting_doc_strings.po
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (21)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: Ubuntu clang (Debug, ubuntu-latest)
  • GitHub Check: Ubuntu clang (Debug, ubuntu-22.04)
  • GitHub Check: Build (56, 3.6.0)
  • GitHub Check: Build (56, 3.6.3)
  • GitHub Check: Build (56, 3.7.3)
  • GitHub Check: macos (macos-latest)
  • GitHub Check: macos (macos-14)
  • GitHub Check: Ubuntu Boost (86)
  • GitHub Check: Ubuntu Boost (77)
  • GitHub Check: Ubuntu Boost (75)
  • GitHub Check: documentation (sv)
  • GitHub Check: Ubuntu Boost (84)
  • GitHub Check: Ubuntu Boost (78)
  • GitHub Check: Ubuntu Boost (76)
  • GitHub Check: Ubuntu Boost (56)
  • GitHub Check: Ubuntu Boost (79)
  • GitHub Check: Build
  • GitHub Check: documentation (es)
  • GitHub Check: documentation (zh_Hans)
  • GitHub Check: Update Website
🔇 Additional comments (14)
doc/chinese/chinesePostmanProblem-family.rst (1)

12-24: Experimental block restructure looks correct.

Title and markers now align with the new experimental convention, and the shared warning include keeps the family documentation consistent.

tools/testers/doc_queries_generator.pl (1)

277-277: Consistent loading pattern for test isolation.

Loading lc101.pg before each test (like sampledata.sql) ensures test isolation with clean data. This is the correct approach for maintaining test independence.

However, if lc101.pg contains substantial data or expensive operations, consider the performance impact on test execution time, especially if there are many test files.

docqueries/version/version.result (1)

8-9: LGTM! Version updated correctly.

The version string has been updated from 4.0.0-alpha1 to 4.0.0-beta1, consistent with the beta release indicated in CMakeLists.txt.

doc/bdAstar/bdAstar-family.rst (1)

56-56: LGTM! Sphinx reference format corrected.

The cross-reference format has been corrected from doc:\pgr_aStar`to:doc:`pgr_aStar``, which is the proper Sphinx syntax for document references.

include/drivers/ordering_driver.hpp (1)

40-40: LGTM! Include added for int64_t support.

The #include <cstdint> directive has been correctly added to provide fixed-width integer type definitions (notably int64_t used in the do_ordering function signature at line 45). The placement after #include <string> is appropriate.

CMakeLists.txt (1)

35-35: LGTM! Version suffix updated for beta1 release.

The development version suffix has been correctly updated from "-alpha1" to "-beta1", marking the progression to the beta1 release. This change is consistent with version updates throughout the PR in documentation and test result files.

Based on learnings: The installed PostgreSQL extension will use the normalized version format "4.0.0" regardless of this suffix.

docqueries/version/full_version.result (1)

7-9: LGTM! Version output updated correctly.

The query result correctly reflects the version update to 4.0.0-beta1, with appropriate header formatting adjustments. This is consistent with the version suffix change in CMakeLists.txt.

doc/dijkstra/pgr_dijkstraVia.rst (2)

13-13: LGTM! Index entry updated for official status.

The index entry has been simplified from "Dijkstra Via - Proposed" to "dijkstraVia", reflecting the function's promotion to official status in version 4.0.0.


28-34: LGTM! Version history properly maintained.

The documentation correctly:

  1. Updates the primary version rubric to 4.0.0 with "Function promoted to official" status
  2. Retains historical context by adding a Version 2.2.0 section noting when it was "New proposed function"

This approach maintains the function's evolution history as recommended in the pgRouting documentation practices.

Based on learnings

doc/src/release_notes.rst (4)

201-217: LGTM! New Dijkstra function entries added.

The release notes correctly document the addition of three new Dijkstra-related functions (pgr_dijkstraNear, pgr_dijkstraNearCost, and pgr_dijkstraVia) with proper references to their respective documentation files using the include directive pattern.


255-283: LGTM! Additional function entries documented.

The release notes properly document:

  • pgr_maxCardinalityMatch (lines 255-259)
  • pgr_sloanOrdering (lines 279-283)

Both entries follow the established pattern with appropriate references to their documentation sections.


321-331: LGTM! TSP function entries added.

The release notes correctly document changes to pgr_TSP and pgr_TSPeuclidean functions with proper references to their respective documentation sections, following the established documentation pattern.


378-391: LGTM! Functions promoted to official list updated.

The "Functions promoted to official" section has been correctly updated to include:

  • pgr_dijkstraNear (issue #2983)
  • pgr_dijkstraNearCost (issue #2983)
  • pgr_dijkstraVia (issue #2983)

These additions are consistent with the function promotions documented elsewhere in the PR.

doc/dijkstra/pgr_dijkstraNear.rst (1)

10-209: Promotion docs read well

Index entries, availability history, and signature blocks now reflect the official status without losing prior-version context. Looks good.

# version: will catch the current version
# mincut: results change depending on boost
TESTDIRS="version mincut"
TESTDIRS="mincut"
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify removal of version testing is intentional.

The TESTDIRS variable has been changed from "version mincut" to "mincut", removing the version-related documentation query tests. While this change may align with documentation reorganization in the PR, please confirm that:

  1. Version query testing is no longer required, or
  2. These tests have been moved to another workflow/location

🏁 Script executed:

#!/bin/bash
# Verify if version query tests exist elsewhere or in docqueries/version/
echo "Checking for version-related query files:"
fd -t f -e queries -e result . docqueries/version/

echo -e "\nChecking for version testing in other workflows:"
rg -n "version.*queries" .github/workflows/

Length of output: 164


Restore version directory to TESTDIRS in check-queries workflow
Add "version" back to the TESTDIRS variable so that docqueries/version/*.queries tests are executed.

🤖 Prompt for AI Agents
.github/workflows/check-queries.yml around line 115: TESTDIRS currently only
contains "mincut", so queries under docqueries/version/*.queries are not run;
update TESTDIRS to include "version" (e.g., TESTDIRS="mincut version" or add
version to whatever list is built) so the workflow runs tests for
docqueries/version/*.queries.

vertex:

- It is expected to terminate faster than pgr_dijkstra
- It is expected to terminate faster than :doc:`pgr_dijkstra`
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Confirm Sphinx target slug.

Switching to :doc:pgr_dijkstra`` only works if there is a document whose path resolves to that slug; otherwise the build will break with an unresolved reference. Please double-check that the canonical doc name is exactly pgr_dijkstra (and not something like `dijkstra-family/pgr_dijkstra`).


🏁 Script executed:

#!/bin/bash
# Verify the presence of a document whose slug is pgr_dijkstra.
fd -e rst -a 'pgr_dijkstra' doc | sort

Length of output: 322


Correct Sphinx doc link path
Change :doc:pgr_dijkstra to `:doc:`dijkstra/pgr_dijkstra to match doc/dijkstra/pgr_dijkstra.rst.
Location: doc/bdDijkstra/bdDijkstra-family.rst:80

🤖 Prompt for AI Agents
In doc/bdDijkstra/bdDijkstra-family.rst around line 80, the Sphinx
cross-reference uses the wrong doc path (:doc:`pgr_dijkstra`); update it to the
correct path used by the project (:doc:`dijkstra/pgr_dijkstra`) so the link
resolves to doc/dijkstra/pgr_dijkstra.rst. Replace the existing
:doc:`pgr_dijkstra` token with :doc:`dijkstra/pgr_dijkstra` preserving
surrounding text and formatting.

Comment on lines +2629 to +2631
"For large graphs where there is a path bewtween the starting vertex and "
"ending vertex:"
msgstr ""
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix typo in documentation string

The English source string now reads “bewtween”. Please correct it to “between” so the published docs don’t inherit the typo.

-msgid ""
-"For large graphs where there is a path bewtween the starting vertex and "
-"ending vertex:"
+msgid ""
+"For large graphs where there is a path between the starting vertex and "
+"ending vertex:"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"For large graphs where there is a path bewtween the starting vertex and "
"ending vertex:"
msgstr ""
msgid ""
"For large graphs where there is a path between the starting vertex and "
"ending vertex:"
msgstr ""
🤖 Prompt for AI Agents
In locale/de/LC_MESSAGES/pgrouting_doc_strings.po around lines 2629 to 2631, the
English source string contains a typo "bewtween"; edit the string to replace
"bewtween" with "between" so it reads "For large graphs where there is a path
between the starting vertex and ending vertex:" and save the PO file.

Comment on lines +2642 to +2643
"For large graphs where there is a path bewtween the starting vertex and "
"ending vertex:"
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix typo in new doc string.

Line 2642 spells "bewtween"—please correct to "between" so the generated docs read properly.

🤖 Prompt for AI Agents
In locale/ko/LC_MESSAGES/pgrouting_doc_strings.po around lines 2642-2643,
there's a typo in the doc string: change "bewtween" to "between" so the
concatenated string reads "For large graphs where there is a path between the
starting vertex and ending vertex:". Make the single-word spelling correction in
that line and save the PO file.

Comment on lines +134 to +145
* pgr_dijkstraNear

* Function promoted to official.

* pgr_dijkstraNearCost

* Function promoted to official.

* pgr_dijkstraVia

* Function promoted to official.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Regenerate NEWS.md via the release script

NEWS.md is auto-generated from source templates (see tools/release-scripts/notes2news.pl). Direct edits here will be lost on the next run and desync the published notes from their source. Please make these additions in the generator inputs and regenerate NEWS.md instead of editing it manually. Based on learnings

Also applies to: 176-258, 323-339

🤖 Prompt for AI Agents
In NEWS.md around lines 134-145 (also applies to ranges 176-258 and 323-339),
the reviewer notes these release notes were edited directly but NEWS.md is
generated by tools/release-scripts/notes2news.pl; undo the manual edits in this
file and instead make the additions in the generator input templates (the source
notes used by tools/release-scripts/notes2news.pl), then run the release script
to regenerate NEWS.md so the changes persist and avoid desync with the automated
pipeline.


# Load the sample data & any other relevant data files
mysystem("$psql $connopts -A -t -q -f tools/testers/sampledata.sql $DBNAME >> $TMP2 2>\&1 ");
mysystem("$psql $connopts -A -t -q -f tools/testers/lc101.pg $DBNAME >> $TMP2 2>\&1 ");
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify that tools/testers/lc101.pg exists in the repository.

The script loads lc101.pg without checking if the file exists. If the file is missing, the load will fail silently, potentially causing downstream test failures with unclear error messages.

Run the following script to verify the file exists:


🏁 Script executed:

#!/bin/bash
# Description: Verify that lc101.pg exists in the expected location

if [ -f "tools/testers/lc101.pg" ]; then
    echo "✓ File exists: tools/testers/lc101.pg"
    echo "File size: $(wc -c < tools/testers/lc101.pg) bytes"
    echo "First 5 lines:"
    head -n 5 tools/testers/lc101.pg
else
    echo "✗ File missing: tools/testers/lc101.pg"
    exit 1
fi

Length of output: 38


Missing test data file tools/testers/lc101.pg
The script references this file in mysystem calls at lines 180 and 277, but it is not present in the repository; add it or correct the path.

🤖 Prompt for AI Agents
tools/testers/doc_queries_generator.pl around lines 180 and 277: the script
invokes tools/testers/lc101.pg which is missing from the repo; either add the
lc101.pg test data file at that path (with the expected SQL contents and
appropriate permissions) or update the script to point to the correct existing
test file path; ensure both invocations (lines ~180 and ~277) are updated
consistently and run the script to verify the psql calls succeed and output to
$TMP2 as intended.

@cvvergara
Copy link
Member Author

@coderabbitai create an issue with the problems you mention

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 10, 2025

Tip

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

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# List all review comments made by coderabbitai on PR #2986
gh pr view 2986 --repo pgRouting/pgrouting --json comments --jq '.comments[] | select(.author.login == "coderabbitai") | {body: .body, url: .url}'

Length of output: 32928


🏁 Script executed:

#!/bin/bash
# Get all my review comments on specific code lines in PR #2986
gh api repos/pgRouting/pgrouting/pulls/2986/comments --paginate | jq -r '.[] | select(.user.login == "coderabbitai") | {body: .body, path: .path, line: .line, url: .html_url}'

Length of output: 0


@cvvergara, I checked my previous comments on this PR and found only my summary/walkthrough comment. I didn't flag any specific problems or issues that would need to be addressed in a separate issue.

Looking at my summary, I provided an overview of the changes (version bump to 4.0.0-beta1, function promotions, documentation updates, etc.) but didn't identify any problems or concerns that require follow-up.

Could you clarify which specific problems you'd like me to create an issue for? If you're referring to something discussed elsewhere or have specific concerns you'd like documented, please let me know and I'll be happy to create an issue for them.

@cvvergara cvvergara merged commit 32e669f into main Oct 11, 2025
70 of 72 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants