Skip to content

Fix grammar and typo in SDG11 workshop documentation - #289

Open
chandan04042003 wants to merge 1 commit into
pgRouting:developfrom
chandan04042003:docs/fix-sdg11-grammar
Open

chandan04042003 wants to merge 1 commit into
pgRouting:developfrom
chandan04042003:docs/fix-sdg11-grammar

Conversation

@chandan04042003

@chandan04042003 chandan04042003 commented Sep 30, 2026 •

Copy link
Copy Markdown

Fixes # .

Changes proposed in this pull request:

Fixes two documentation issues in the SDG11 waterways exercise:

  • Adds the missing preposition "on"
  • Corrects the typo "wich" to "which"

@pgRouting/admins

Summary by CodeRabbit

  • Documentation
    • Clarified that the exercise focuses on mainland areas and corrected a spelling error in the swamp-area description.

@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: a1b43895-d370-4467-b86d-c08b711a97d4

📥 Commits

Reviewing files that changed from the base of the PR and between 750ff4d and 01377b1.

📒 Files selected for processing (1)
  • docs/un_sdg/sdg11-cities.rst

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

The SDG 11 exercise description corrects the phrase “only the areas” to “only on the areas” and fixes the spelling of “which.” It still refers to mainland areas and swamp rivers for removal.

Changes

SDG 11 exercise description

Layer / File(s) Summary
Exercise description wording
docs/un_sdg/sdg11-cities.rst
The text changes “only the areas” to “only on the areas” and corrects “wich” to “which.” The description still identifies mainland areas and swamp rivers for removal.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 01377

No material behavior or documentation-contract risk remains; the exercise scope is unchanged.

Architecture Summary

Architecture risk: 🔵 Low · up to 01377

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/un_sdg/sdg11-cities.rst: The description changes “only the areas” to “only on the areas” and corrects “wich” to “which”; it still identifies mainland areas and swamp rivers for removal.
🚥 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 clearly and concisely describes the two documentation edits in the pull request: a grammar fix and a typo correction in the SDG11 workshop documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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

A rabbit reads the wording anew,
And spots a small spelling fix, too.
Mainland areas stay in the line,
Swamp rivers remain by design.
With clearer words, the page is through.

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

@chandan04042003

Copy link
Copy Markdown
Author

@cvvergara can you please review this pr, and guide me in the next steps!

This branch has not been deployed

No deployments
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