Skip to content

Conversation

@cvvergara
Copy link
Member

@cvvergara cvvergara commented Nov 28, 2025

Fixes #266
During the FOSS4G 2025 it was noticed that the workshop did not match the data on OSGeoLive 17

Changes proposed in this pull request:

  • The Files on download were updated
  • The correct file name is AUCKLAND_NZ

@pgRouting/admins

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated data file references in workshop documentation.
    • Refreshed example routing paths and timing information in pedestrian workshop guides.
  • Chores

    • Updated localization metadata and translation strings.

✏️ Tip: You can customize this high-level summary in your review settings.

@cvvergara cvvergara added this to the FOSS4G 2025 milestone Nov 28, 2025
@cvvergara cvvergara self-assigned this Nov 28, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 28, 2025

Walkthrough

This PR updates the workshop configuration and localization files to enforce consistent uppercase naming for the Auckland dataset file (AUCKLAND_NZ). Changes include updating the CMake constant, related translation strings across POT and locale files, and refreshing pedestrian tutorial vertex references with corresponding timing metadata.

Changes

Cohort / File(s) Change Summary
Configuration constant
CMakeLists.txt
Updated PGR_WORKSHOP_CITY_FILE constant from auckland_NZ to AUCKLAND_NZ for filename consistency.
Data localization files
locale/pot/basic/data.pot, locale/en/LC_MESSAGES/basic/data.po
Updated POT creation metadata and filename references from auckland_NZ.osm to AUCKLAND_NZ.osm to match uppercase naming convention.
Pedestrian localization files
locale/pot/basic/pedestrian.pot, locale/en/LC_MESSAGES/basic/pedestrian.po
Updated POT creation metadata and refreshed origin-destination vertex pairs in tutorial notes (e.g., 10840→10928 to 10832→11046) with corresponding timing sequences.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Homogeneous, repetitive changes: case normalization of filename constant and references across multiple files
  • No logic modifications, control-flow changes, or public API alterations
  • Straightforward configuration and localization metadata updates

Possibly related PRs

  • Pumpup to auckland #255: Introduced the original lowercase auckland_NZ city-file constant and initial corresponding translation strings; this PR standardizes the casing to uppercase.
  • Chapter pedestrian rewrite #257: Related pedestrian chapter documentation rewrite that overlaps with the pedestrian translation string updates for vertex references and tutorial examples in this PR.

Suggested reviewers

  • iosefa

Poem

🐰 Hops through the files with glee,
Upper-casing constants—one, two, three!
Auckland now shouts in CAPS so bright,
Vertices dance to new heights,
Consistency hops, the workshop takes flight!

Pre-merge checks and finishing touches

✅ Passed checks (5 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 describes the main change: updating Auckland data to match OSGeoLive standards, which is the primary objective of this pull request.
Linked Issues check ✅ Passed The pull request successfully implements the requirement from issue #266 by updating the file name from 'auckland_NZ' to 'AUCKLAND_NZ' across all relevant files (CMakeLists.txt, locale files, and POT files).
Out of Scope Changes check ✅ Passed All changes are directly related to the linked issue #266: updating the file name constant and all references from 'auckland_NZ' to 'AUCKLAND_NZ', plus necessary updates to translation files and vertex references that reflect the corrected OSGeoLive data.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 59b8178 and 3570711.

📒 Files selected for processing (5)
  • CMakeLists.txt (1 hunks)
  • locale/en/LC_MESSAGES/basic/data.po (2 hunks)
  • locale/en/LC_MESSAGES/basic/pedestrian.po (2 hunks)
  • locale/pot/basic/data.pot (2 hunks)
  • locale/pot/basic/pedestrian.pot (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-30T18:27:06.879Z
Learnt from: cvvergara
Repo: pgRouting/workshop PR: 255
File: CMakeLists.txt:65-70
Timestamp: 2025-09-30T18:27:06.879Z
Learning: In CMakeLists.txt for pgRouting workshop, OSM IDs (OSMID_1 through OSMID_5) are intentionally set to road/way nodes near landmarks rather than the landmark objects themselves, as they need to be part of navigable ways for routing purposes.

Applied to files:

  • CMakeLists.txt
⏰ 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). (1)
  • GitHub Check: Build
🔇 Additional comments (9)
locale/pot/basic/data.pot (2)

11-11: LGTM! POT metadata updated appropriately.

The POT-Creation-Date timestamp reflects when this translation template was regenerated.


132-132: LGTM! Filename reference updated to match OSGeoLive convention.

The documentation string now correctly references AUCKLAND_NZ.osm consistent with the CMakeLists.txt configuration change.

locale/en/LC_MESSAGES/basic/data.po (2)

12-12: LGTM! Locale file timestamp synchronized with template.


159-159: LGTM! Documentation correctly references the updated filename.

locale/en/LC_MESSAGES/basic/pedestrian.po (2)

12-12: LGTM! Translation file timestamp updated.


342-355: Based on my investigation, I cannot complete full verification of the vertex IDs and timings due to technical limitations. Here's what I found:

Key Findings:

  1. Repository Access Issue: The repository clone failed, preventing direct verification of the source documentation scripts that feed these values into the .po file.

  2. Auto-Generated File: The .po file is auto-generated from Sphinx documentation builds, not manually maintained. The values should originate from source documentation scripts in build/docs/scripts/basic/pedestrian/note_1.txt.

  3. Known Dataset Mismatch: Web searches confirm a documented issue with OSGeoLive 17 Auckland dataset—the data on the ISO/disk differs from the downloadable version (including filename case differences: auckland_NZ.osm.bz2 vs AUCKLAND_NZ.osm.bz2). The pgRouting workshop was created using the download version, not the ISO version.

  4. Partial Confirmation: Web searches confirm that vertex IDs 10832 and 11046 are referenced in official pgRouting workshop documentation and are valid for pedestrian routing examples, but cannot verify they exist in the specific OSGeoLive 17 release or that the 9.07-minute timing is accurate.

Unable to Verify:

  • Whether these specific vertex IDs exist in the OSGeoLive 17 dataset deployed on the ISO
  • Whether the 9.07-minute travel time is accurate without running actual pgr_dijkstra queries

Manual verification required: Someone with access to the OSGeoLive 17 Auckland database should run the pgr_dijkstra queries provided in the review comment to confirm the vertex IDs and timings match the actual dataset.

locale/pot/basic/pedestrian.pot (2)

11-11: LGTM! Template timestamp updated.


294-307: LGTM! Vertex updates consistent with locale files.

The template reflects the same vertex ID and timing updates as the English locale file. Verification of these values against the OSGeoLive 17 dataset was requested in the corresponding .po file review.

CMakeLists.txt (1)

48-48: Critical: Verify this change doesn't break download scenarios

The change from "auckland_NZ" to "AUCKLAND_NZ" aligns with the OSGeoLive disk copy filename convention. However, web research reveals that OSGeoLive downloads use the lowercase "auckland_NZ.osm.bz2" while the disk copy uses uppercase "AUCKLAND_NZ.osm.bz2".

Before approving, verify:

  • Is PGR_WORKSHOP_CITY_FILE used in download-specific code paths that should retain the lowercase version?
  • Are there other references to the old filename pattern that need updating for consistency?
  • Is there logic to handle both download and disk scenarios appropriately?

The change cannot be fully verified due to inability to access the repository codebase.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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.

@cvvergara cvvergara merged commit 6114f86 into pgRouting:develop Nov 28, 2025
2 checks passed
@cvvergara cvvergara deleted the fixing-auckland-data-to-match-osgeolive-data branch November 28, 2025 20:32
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.

Use correct file name from OSGeoLive

1 participant