Skip to content

Fix typos and grammar in workshop documentation - #291

Open
Sankalp-2711 wants to merge 1 commit into
pgRouting:developfrom
Sankalp-2711:fix-workshop-documentation
Open

Sankalp-2711 wants to merge 1 commit into
pgRouting:developfrom
Sankalp-2711:fix-workshop-documentation

Conversation

@Sankalp-2711

@Sankalp-2711 Sankalp-2711 commented Oct 13, 2026 •

Copy link
Copy Markdown

Changes proposed in this pull request:

  • Correct spelling and grammar in chapter-9.rst.
  • Improve wording and terminology in the UN SDG documentation.
  • Fix typos in the PostgreSQL reference.

Local checks:

  • git diff --check — passed.
  • make html — completed successfully for English, Spanish, Japanese, and Swedish.

@pgRouting/admins

Summary by CodeRabbit

  • Documentation
    • Corrected spelling, capitalization, and wording across the QGIS, SDG, and PostgreSQL guides.
    • Clarified instructions for preparing a waterways processing graph and adding a rain-zone column.
    • Corrected the name of SDG Goal 9 in the overview table.

@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

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: 5c534438-8358-4ecd-9d4c-ec4bad61c29c
📥 Commits

Reviewing files that changed from the base of the PR and between 750ff4d and 4eb7681.

📒 Files selected for processing (4)
  • docs/interactions/chapter-9.rst
  • docs/un_sdg/introduction.rst
  • docs/un_sdg/sdg11-cities.rst
  • docs/un_sdg/sdg3-health.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

This change corrects wording, spelling, and capitalization in the QGIS and UN SDG documentation. It also updates the rain-zone instruction to refer to adding one rain_zone column.

Changes

Documentation edits

Layer / File(s) Summary
QGIS setup and styling instructions
docs/interactions/chapter-9.rst
Corrects capitalization, spelling, and wording in the chapter introduction, setup instructions, and style-copy instruction.
UN SDG page text and instructions
docs/un_sdg/sdg11-cities.rst, docs/un_sdg/introduction.rst, docs/un_sdg/sdg3-health.rst
Corrects wording in the SDG 11 page, changes the rain-zone instruction to refer to one column, adds punctuation to the Goal 9 name, and corrects the PostgreSQL heading.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: cvvergara

Merge Risk: ⚪ Minimal · up to 4eb76

The rain-zone tutorial instructs readers to add the column its SQL uses, and the other changes are editorial. No material merge risk is identified.

### Architecture Summary

Architecture risk: 🔵 Low · up to 4eb76

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; 4 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/interactions/chapter-9.rst: The heading changes “Qgis” to “QGIS”; the introductory text corrects “Other kind” to “Other kinds” and “applications requirements” to “application requirements.”
  • observed — Modified behavior in docs/interactions/chapter-9.rst: The QGIS setup steps correct spelling and capitalization in the browser-panel instruction and the PostGIS database connection instruction.
  • observed — Modified behavior in docs/interactions/chapter-9.rst: The login-and-password instruction and “Add a PostGIS Layer” heading capitalize QGIS and PostGIS and correct the wording.
  • observed — Modified behavior in docs/interactions/chapter-9.rst: The style-copy instruction corrects “formmated” to “formatted.”
Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
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.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the primary changes: typo, spelling, and grammar corrections across the workshop documentation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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 checks the words in flight
And sets each QGIS letter right
One rain-zone column joins the page
While typos hop out of the stage
The SDG lines shine tonight

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

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.

1 participant