Skip to content

Docs: Clean up phrasing, fix typos, convert text to URL#275

Merged
cvvergara merged 7 commits into
pgRouting:developfrom
Fawaz-Lawal:develop
Jun 14, 2026
Merged

Docs: Clean up phrasing, fix typos, convert text to URL#275
cvvergara merged 7 commits into
pgRouting:developfrom
Fawaz-Lawal:develop

Conversation

@Fawaz-Lawal

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

Copy link
Copy Markdown
Contributor

Fixes # .

Changes proposed in this pull request:

  • Corrected some grammatical errors
  • Restructured some sentences for more meaning
  • Converted text to URL to enhance reader experience

@pgRouting/admins

Summary by CodeRabbit

  • Documentation
    • Improved clarity and grammar across documentation sections
    • Corrected UI field naming guidance
    • Fixed spelling, punctuation, and wording inconsistencies for enhanced readability

@coderabbitai

coderabbitai Bot commented Jun 14, 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: 98596196-8b94-4526-86d4-58587fd2bb39

📥 Commits

Reviewing files that changed from the base of the PR and between 6114f86 and 4675346.

📒 Files selected for processing (7)
  • docs/interactions/chapter-10.rst
  • docs/interactions/chapter-9.rst
  • docs/un_sdg/data.rst
  • docs/un_sdg/introduction.rst
  • docs/un_sdg/sdg11-cities.rst
  • docs/un_sdg/sdg3-health.rst
  • docs/un_sdg/sdg7-energy.rst

Walkthrough

Seven single-line documentation corrections across docs/interactions and docs/un_sdg: a GeoServer field label rename, a missing preposition, a product name spelling/spacing fix, a punctuation and word removal, a plural correction, an introductory sentence touch, and a spelling/punctuation fix.

Changes

Documentation text corrections

Layer / File(s) Summary
Prose and punctuation corrections across workshop docs
docs/interactions/chapter-10.rst, docs/interactions/chapter-9.rst, docs/un_sdg/data.rst, docs/un_sdg/introduction.rst, docs/un_sdg/sdg11-cities.rst, docs/un_sdg/sdg3-health.rst, docs/un_sdg/sdg7-energy.rst
"Namespace URI" changed to "Namespace URL"; added missing "in" before pl/pgsql; "OpenStreetMaps(OSM)" corrected to "OpenStreetMap (OSM)"; removed extraneous "and" and fixed comma spacing in target-audience sentence; "single edge" pluralized to "single edges"; introductory sentence in sdg3-health touched; comma added after "Today" and "focusses" corrected to "focuses" in sdg7-energy.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A hop through the docs, a twitch of my nose,
"Namespace URL" now correctly shows.
A comma here, a plural there,
"focuses" spelled with bunny-like care.
The workshop gleams, the words align —
🐇 Every sentence hops in a straight line!

🚥 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 title 'Docs: Clean up phrasing, fix typos, convert text to URL' directly matches the PR's main objectives of fixing grammatical errors, restructuring sentences, and converting text to URLs across 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

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 15fbf05 into pgRouting:develop Jun 14, 2026
2 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.

2 participants