Skip to content

docs: fix typos, RST link formatting, and exercise numbering order #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AdityaRanaX wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

docs: fix typos, RST link formatting, and exercise numbering order #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a80568
docs: fix typos and malformed RST links in general-intro and basic ch…
AdityaRanaX Sep 16, 2026
ce7e032
docs(sql_function): fix exercise numbering order and typos
AdityaRanaX Sep 16, 2026
0fbed73
docs(graphs): clarify cost matrix wording and fix subject-verb agreement
AdityaRanaX Sep 23, 2026
3533a99
Update locale: commit 0fbed732
github-actions[bot] Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/basic/data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Connect to the database

psql city_routing

Install pgRouting and its requirements. (otpionally check the version that is
Install pgRouting and its requirements. (optionally check the version that is
being used)

.. literalinclude:: ../scripts/get_data/setup_city_routing.sh
Expand All @@ -68,7 +68,7 @@ of @DATE_OF_DATA@.
Get the data
-------------------------------------------------------------------------------

Download data form pgRouting download
Download data from pgRouting download
...............................................................................

The exact same data can be found on the OSGeoLive download page.
Expand Down
12 changes: 6 additions & 6 deletions docs/basic/graphs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ Count the number of rows that need to be filled up.
Exercise 3: Use QGIS to view the work
-------------------------------------------------------------------------------

QGIS is a powerfull tool
QGIS is a powerful tool

If you are using OSGeoLive, then you can find QGIS here:

Expand Down Expand Up @@ -316,7 +316,7 @@ Create additional columns on the edges tables.
.. note:: This is not a QGIS workshop, so the details about how to display
layers are not written in this workshop

.. rubric:: Update the edges table with based on the component number of the vertex
.. rubric:: Update the edges table based on the component number of the vertex

.. literalinclude:: ../scripts/basic/graphs/graphs.sql
:language: sql
Expand Down Expand Up @@ -399,7 +399,7 @@ Count the distinct components.
:start-after: see_components4.txt
:end-before: create_vehicle_net1.txt

.. collapse:: Component with maxmum edge count
.. collapse:: Component with maximum edge count

.. literalinclude:: ../scripts/basic/graphs/see_components4.txt

Expand Down Expand Up @@ -645,8 +645,8 @@ Exercise 9: Testing the views

In particular:

* Get a traveling cost matrix in seconds from the all follwoing ``id`` to all
the ``id``
* Get a traveling cost matrix in seconds from each of the following ``id``
values to all of the other ``id`` values

* |id_1|, |id_2|, |id_3|, |id_4| and |id_5|.

Expand Down Expand Up @@ -726,7 +726,7 @@ Exercise 10: Visualize on QGIS the ``pgr_costMatrix`` result
Based on the query from `Exercise 9: Testing the views`_, create a view to be
able to use on QGIS. (like the one above)

* The results when using ``vehile_net`` is the example.
* The results when using ``vehicle_net`` are the example.
* The other results are left to the reader.

.. rubric:: Solution
Expand Down
8 changes: 4 additions & 4 deletions docs/basic/pedestrian.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ Identifiers for the Queries

The assignment of the vertices identifiers on the source and target columns may
be different, the exercises will use the identifiers value assigned by
``oms2pgrouting``
``osm2pgrouting``

For the workshop, some locations near of the FOSS4G event are going to be used.
For the workshop, some locations near the FOSS4G event are going to be used.
These locations are within this area |osm_map_link|

* |osmid_1| |place_1|
Expand All @@ -37,7 +37,7 @@ These locations are within this area |osm_map_link|
* |osmid_5| |place_5|

.. note::
Don'f forget to connect to the database, if not connected:
Don't forget to connect to the database, if not connected:

::

Expand Down Expand Up @@ -361,7 +361,7 @@ Exercise 6: Time for many Pedestrians going to different destinations

.. literalinclude:: ../scripts/basic/pedestrian/dijkstracost.txt

The sanme results can be obtained from the ``pedestrian_many_to_many`` view:
The same results can be obtained from the ``pedestrian_many_to_many`` view:

.. literalinclude:: ../scripts/basic/pedestrian/pedestrian.sql
:language: sql
Expand Down
10 changes: 5 additions & 5 deletions docs/basic/sql_function.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,14 @@ Get the geometries in readable form of the route from |place_1| to |place_2|

.. literalinclude:: ../scripts/basic/sql_function/get_read_geom.txt

Exercise 5: Get the azimuth
Exercise 4: Get the azimuth
-------------------------------------------------------------------------------

.. image:: images/sql_function/route_azimuth.png
:width: 300pt
:alt: Route showing azimuth

There are many geometry functions in PostGIS, the workshop coveres some
There are many geometry functions in PostGIS, the workshop covers some
of them like ``ST_AsText``, ``ST_Reverse``, ``ST_EndPoint``, ``ST_Azimuth``.

.. rubric:: Problem
Expand All @@ -185,12 +185,12 @@ Get the azimuth of the geometries of the route from |place_1| to |place_2|
.. literalinclude:: ../scripts/basic/sql_function/get_azimuth.txt


Exercise 4: Route geometry directionality
Exercise 5: Route geometry directionality
-------------------------------------------------------------------------------

.. image:: images/sql_function/wrong_directionality.png
:width: 300pt
:alt: wrong direccionality
:alt: wrong directionality

Visually, with the route displayed with arrows, it can be found that there are
arrows that do not match the directionality of the route.
Expand Down Expand Up @@ -249,7 +249,7 @@ Inspecting the problematic rows, the directionality has been fixed.

.. image:: images/sql_function/good_directionality.png
:width: 300pt
:alt: good direccionality
:alt: good directionality

Writing the final function
-------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/basic/vehicle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Cost manipulations
In this workshop, costs are going to be manipulated using the ``configuration``
table.

Exercise 4: Create a penalazied view
Exercise 4: Create a penalized view
...............................................................................

.. rubric:: Problem:
Expand Down
6 changes: 3 additions & 3 deletions docs/basic/withPoints.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Get the nearest edge on the graph of the following points.

.. rubric:: Solution

* Build the geometry of the points with the appropiate SRID.
* Build the geometry of the points with the appropriate SRID.
* Get the union of the individual queries

.. literalinclude:: ../scripts/basic/withPoints/withPoints.sql
Expand Down Expand Up @@ -152,7 +152,7 @@ Route from point **1** to point **2** on the ``vehicle_net`` where:

* The query from `Exercise 1: Get the nearest edge`_ is used as the inner query
for points.
* Using negative values to avoid conficts with vertices with the same value:
* Using negative values to avoid conflicts with vertices with the same value:

* Routing from point **-1** to point **-2**

Expand Down Expand Up @@ -220,7 +220,7 @@ The points SQL:

The routing results:

* The query looks like the one on `Exercise 2: Point routing`
* The query looks like the one on `Exercise 2: Point routing`_
* Using PostgreSQL ``format`` to make substitutions.

* The ``points_sql`` value will replace ``%1$s``.
Expand Down
2 changes: 1 addition & 1 deletion docs/general-intro/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ section covers several graph problems that can be solved using pgRouting.
* Previous knowledge: PostgreSQL, PostGIS, pgRouting basic level.
* Equipments: `OSGeoLive <https://live.osgeo.org>`__ (@OSGeoLive_VERSION@)

Aknowledments
Acknowledgments
-------------------------------------------------------------------------------

.. rubric:: Sponsored by
Expand Down
8 changes: 4 additions & 4 deletions docs/general-intro/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ geospatial routing functionality.

Advantages of the database routing approach are:

* Data and attributes are stored on a PostreSQL database and as such they can be
modified can be modified by many clients.
* Data and attributes are stored on a PostgreSQL database and as such they can be
modified by many clients.
* Data changes can be reflected instantaneously through the routing engine.
There is no need for pre-calculation.
* The “cost” parameter can be dynamically calculated through SQL and its value
Expand All @@ -40,8 +40,8 @@ Advantages of the database routing approach are:
Some of the pgRouting library core features are:

* `Functions based on Dijkstra Algorithm <https://docs.pgrouting.org/latest/en/dijkstra-family.html>`__
* `Functions based on `A* Search Algorithm <https://docs.pgrouting.org/latest/en/aStar-family.html>`__
* `Graph commponent functions <https://docs.pgrouting.org/latest/en/components-family.html>`__
* `Functions based on A* Search Algorithm <https://docs.pgrouting.org/latest/en/aStar-family.html>`__
* `Graph component functions <https://docs.pgrouting.org/latest/en/components-family.html>`__
* `and many more <https://docs.pgrouting.org/latest/en/routingFunctions.html>`_

pgRouting is an open source software available under the GPLv2 license and is
Expand Down
6 changes: 3 additions & 3 deletions locale/en/LC_MESSAGES/basic/data.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Workshop FOSS4G Belém 3.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-07-01 17:09+0000\n"
"POT-Creation-Date: 2026-09-23 05:28+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
Expand Down Expand Up @@ -75,7 +75,7 @@ msgstr ""

#: ../../build/docs/basic/data.rst:48
msgid ""
"Install pgRouting and its requirements. (otpionally check the version that "
"Install pgRouting and its requirements. (optionally check the version that "
"is being used)"
msgstr ""

Expand All @@ -98,7 +98,7 @@ msgid "Get the data"
msgstr ""

#: ../../build/docs/basic/data.rst:72
msgid "Download data form pgRouting download"
msgid "Download data from pgRouting download"
msgstr ""

#: ../../build/docs/basic/data.rst:74
Expand Down
12 changes: 6 additions & 6 deletions locale/en/LC_MESSAGES/basic/graphs.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Workshop FOSS4G Belém 3.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-06-25 21:50+0000\n"
"POT-Creation-Date: 2026-09-23 05:28+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
Expand Down Expand Up @@ -278,7 +278,7 @@ msgid "Exercise 3: Use QGIS to view the work"
msgstr ""

#: ../../build/docs/basic/graphs.rst:224
msgid "QGIS is a powerfull tool"
msgid "QGIS is a powerful tool"
msgstr ""

#: ../../build/docs/basic/graphs.rst:226
Expand Down Expand Up @@ -342,7 +342,7 @@ msgid ""
msgstr ""

#: ../../build/docs/basic/graphs.rst:320
msgid "Update the edges table with based on the component number of the vertex"
msgid "Update the edges table based on the component number of the vertex"
msgstr ""

#: ../../build/docs/basic/graphs.rst:339
Expand Down Expand Up @@ -639,8 +639,8 @@ msgstr ""

#: ../../build/docs/basic/graphs.rst:648
msgid ""
"Get a traveling cost matrix in seconds from the all follwoing ``id`` to all "
"the ``id``"
"Get a traveling cost matrix in seconds from each of the following ``id`` "
"values to all of the other ``id`` values"
msgstr ""

#: ../../build/docs/basic/graphs.rst:651 ../../build/docs/basic/graphs.rst:663
Expand Down Expand Up @@ -728,7 +728,7 @@ msgid ""
msgstr ""

#: ../../build/docs/basic/graphs.rst:729
msgid "The results when using ``vehile_net`` is the example."
msgid "The results when using ``vehicle_net`` are the example."
msgstr ""

#: ../../build/docs/basic/graphs.rst:730
Expand Down
12 changes: 6 additions & 6 deletions locale/en/LC_MESSAGES/basic/pedestrian.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Workshop FOSS4G Belém 3.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-06-25 21:50+0000\n"
"POT-Creation-Date: 2026-09-23 05:28+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
Expand Down Expand Up @@ -55,13 +55,13 @@ msgstr ""
msgid ""
"The assignment of the vertices identifiers on the source and target columns "
"may be different, the exercises will use the identifiers value assigned by "
"``oms2pgrouting``"
"``osm2pgrouting``"
msgstr ""

#: ../../build/docs/basic/pedestrian.rst:30
msgid ""
"For the workshop, some locations near of the FOSS4G event are going to be "
"used. These locations are within this area |osm_map_link|"
"For the workshop, some locations near the FOSS4G event are going to be used. "
"These locations are within this area |osm_map_link|"
msgstr ""

#: ../../build/docs/basic/pedestrian.rst:33
Expand All @@ -85,7 +85,7 @@ msgid "|osmid_5| |place_5|"
msgstr ""

#: ../../build/docs/basic/pedestrian.rst:40
msgid "Don'f forget to connect to the database, if not connected:"
msgid "Don't forget to connect to the database, if not connected:"
msgstr ""

#: ../../build/docs/basic/pedestrian.rst:46
Expand Down Expand Up @@ -435,5 +435,5 @@ msgstr ""

#: ../../build/docs/basic/pedestrian.rst:364
msgid ""
"The sanme results can be obtained from the ``pedestrian_many_to_many`` view:"
"The same results can be obtained from the ``pedestrian_many_to_many`` view:"
msgstr ""
12 changes: 6 additions & 6 deletions locale/en/LC_MESSAGES/basic/sql_function.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Workshop FOSS4G Belém 3.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-07-01 17:09+0000\n"
"POT-Creation-Date: 2026-09-23 05:28+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
Expand Down Expand Up @@ -335,7 +335,7 @@ msgid "Select the column ``readable``."
msgstr ""

#: ../../build/docs/basic/sql_function.rst:161
msgid "Exercise 5: Get the azimuth"
msgid "Exercise 4: Get the azimuth"
msgstr ""

#: ../../build/docs/basic/sql_function.rst:163
Expand All @@ -344,7 +344,7 @@ msgstr ""

#: ../../build/docs/basic/sql_function.rst:167
msgid ""
"There are many geometry functions in PostGIS, the workshop coveres some of "
"There are many geometry functions in PostGIS, the workshop covers some of "
"them like ``ST_AsText``, ``ST_Reverse``, ``ST_EndPoint``, ``ST_Azimuth``."
msgstr ""

Expand All @@ -358,11 +358,11 @@ msgid "The function returns ``azimuth``."
msgstr ""

#: ../../build/docs/basic/sql_function.rst:189
msgid "Exercise 4: Route geometry directionality"
msgid "Exercise 5: Route geometry directionality"
msgstr ""

#: ../../build/docs/basic/sql_function.rst:191
msgid "wrong direccionality"
msgid "wrong directionality"
msgstr ""

#: ../../build/docs/basic/sql_function.rst:195
Expand Down Expand Up @@ -416,7 +416,7 @@ msgid "Inspecting the problematic rows, the directionality has been fixed."
msgstr ""

#: ../../build/docs/basic/sql_function.rst:250
msgid "good direccionality"
msgid "good directionality"
msgstr ""

#: ../../build/docs/basic/sql_function.rst:255
Expand Down
4 changes: 2 additions & 2 deletions locale/en/LC_MESSAGES/basic/vehicle.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Workshop FOSS4G Belém 3.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-06-25 21:50+0000\n"
"POT-Creation-Date: 2026-09-23 05:28+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
Expand Down Expand Up @@ -264,7 +264,7 @@ msgid ""
msgstr ""

#: ../../build/docs/basic/vehicle.rst:180
msgid "Exercise 4: Create a penalazied view"
msgid "Exercise 4: Create a penalized view"
msgstr ""

#: ../../build/docs/basic/vehicle.rst:184
Expand Down
Loading