Skip to content

Fix workshop typos#278

Open
Fawaz-Lawal wants to merge 16 commits into
pgRouting:developfrom
Fawaz-Lawal:Fix-workshop-typos
Open

Fix workshop typos#278
Fawaz-Lawal wants to merge 16 commits into
pgRouting:developfrom
Fawaz-Lawal:Fix-workshop-typos

Conversation

@Fawaz-Lawal

@Fawaz-Lawal Fawaz-Lawal commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Fixes # .

Changes proposed in this pull request:

  • Went through the webpage and noticed the OSM overview has been removed due to indentation error. It has been corrected.

@pgRouting/admins

Summary by CodeRabbit

Release Notes

  • Documentation
    • Improved clarity and wording throughout workshop guides covering routing concepts, installation instructions, and data handling
    • Enhanced formatting and structure in introductory materials and foundational routing tutorials
    • Updated explanations for better understanding of pgRouting functionality and practical use cases

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 021ce154-543b-4c6a-8d12-e3bf9c9e7df3

📥 Commits

Reviewing files that changed from the base of the PR and between 55f670e and 9176cd5.

📒 Files selected for processing (9)
  • docs/basic/data.rst
  • docs/basic/graphs.rst
  • docs/basic/pedestrian.rst
  • docs/basic/sql_function.rst
  • docs/basic/vehicle.rst
  • docs/basic/withPoints.rst
  • docs/general-intro/introduction.rst
  • docs/general-intro/osgeolive.rst
  • docs/general-intro/overview.rst

Walkthrough

Nine reStructuredText documentation files in the pgRouting workshop received prose corrections, grammar fixes, punctuation normalization, and link reformatting. Changes span general-intro files (overview.rst, introduction.rst, osgeolive.rst) and basic-level chapters (graphs.rst, pedestrian.rst, vehicle.rst, withPoints.rst, sql_function.rst, data.rst). No code, APIs, or configurations were modified.

Changes

Workshop Documentation Copy Edits

Layer / File(s) Summary
General intro prose, links, and acknowledgements
docs/general-intro/overview.rst, docs/general-intro/introduction.rst, docs/general-intro/osgeolive.rst
Corrected grammar in overview opening sentence; reworked pgRouting feature/license bullets and OSM quoted block into prose with explicit source link; reformatted introduction Basic/Advanced bullet punctuation, plpgsql markup, and acknowledgements rubrics with colons; rewrote OSGeoLive VirtualBox VM creation fields and Storage/optical-drive step wording.
Basic chapter prose corrections and link reformatting
docs/basic/graphs.rst, docs/basic/pedestrian.rst, docs/basic/vehicle.rst, docs/basic/withPoints.rst, docs/basic/sql_function.rst, docs/basic/data.rst
Fixed subject-verb agreement and expanded graph requirements description in graphs.rst; added JOIN-with-configuration clarification; removed extra comma and expanded contraction in pedestrian.rst; added vehicle-routing scope sentence and fixed CO₂ bullet indentation in vehicle.rst; rewrote PL/pgSQL explanation paragraph in withPoints.rst; rewrote SQL function intro and adjusted geometry-handling sentence in sql_function.rst; reformatted OSM download link from raw URL to reStructuredText here <…> form in data.rst.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • pgRouting/workshop#259: Rewrote the same docs/basic/sql_function.rst SQL function chapter and geometry-handling prose that this PR also adjusts.
  • pgRouting/workshop#260: Added the full docs/basic/withPoints.rst chapter whose PL/pgSQL introductory paragraph this PR rewrites.

Suggested reviewers

  • iosefa
  • cvvergara

Poem

🐇 A comma removed, a contraction unwound,
The docs grow more precise, clear, and sound.
"Cannot" instead of "can not" — hooray!
A link wrapped in here <> shows the way.
Small nibbles of text, but the warren is bright,
Every sentence now reads with more delight! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'Fix workshop typos' accurately reflects the primary purpose of the changeset, which involves fixing typos and formatting issues across multiple workshop documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch Fix-workshop-typos

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.

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.

1 participant