Skip to content
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.

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

Fix english typos 2 #2380

Merged
merged 9 commits into from
Sep 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 .github/workflows/boost_version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ on:
- 'include/**'
- 'pgtap/**'
- 'tools/testers/**'
- 'CMakeLists.txt'
- './CMakeLists.txt'

branches-ignore:
- 'gh-pages'
Expand All @@ -42,7 +42,7 @@ on:
- 'include/**'
- 'pgtap/**'
- 'tools/testers/**'
- 'CMakeLists.txt'
- './CMakeLists.txt'

branches-ignore:
- 'gh-pages'
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/clang.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ on:
- 'include/**'
- 'pgtap/**'
- 'tools/testers/**'
- 'CMakeLists.txt'
- './CMakeLists.txt'

branches-ignore:
- 'gh-pages'
Expand All @@ -32,7 +32,7 @@ on:
- 'include/**'
- 'pgtap/**'
- 'tools/testers/**'
- 'CMakeLists.txt'
- './CMakeLists.txt'

branches-ignore:
- 'gh-pages'
Expand Down
94 changes: 94 additions & 0 deletions .github/workflows/update-locale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: Update Locale

# This action runs:
# - When this file changes
# - When changes on documentation (doc)
# - When is triggered manually

on:
workflow_dispatch:
push:
paths:
- '.github/workflows/update-locale.yml'
- 'doc/**'

branches-ignore:
- 'gh-pages'

permissions:
contents: read

jobs:
update-locale:
permissions:
contents: write # for Git to git push
name: Update Locale
runs-on: ubuntu-latest

strategy:
fail-fast: false

steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Get postgres version
run: |
sudo service postgresql start
PGVER=$(psql --version | grep -Po '(?<=psql \(PostgreSQL\) )[^;]+(?=\.\d \()')
PROJECT_VERSION=$(grep -Po '(?<=project\(PGROUTING VERSION )[^;]+' CMakeLists.txt)
echo "PGVER=${PGVER}" >> $GITHUB_ENV
echo "PGPORT=5432" >> $GITHUB_ENV
echo "PGIS=3" >> $GITHUB_ENV
echo "PROJECT_VERSION=${PROJECT_VERSION}" >> $GITHUB_ENV

- name: Extract branch name and commit hash
run: |
branch=${GITHUB_REF#refs/heads/}
git_hash=$(git rev-parse --short "$GITHUB_SHA")
echo "GIT_HASH=$git_hash" >> $GITHUB_ENV

- name: Add PostgreSQL APT repository
run: |
sudo apt-get install curl ca-certificates gnupg
curl https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ \
$(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'

- name: Install python
uses: actions/setup-python@v3
with:
python-version: '3.x'

- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y \
libboost-graph-dev \
postgresql-${PGVER} \
postgresql-${PGVER}-postgis-${PGIS} \
postgresql-${PGVER}-postgis-${PGIS}-scripts \
postgresql-server-dev-${PGVER} \
graphviz \
doxygen
python -m pip install --upgrade pip
pip install Sphinx
pip install sphinx-bootstrap-theme
pip install sphinx-intl[transifex]
pip list

- name: Initialize mandatory git config
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

- name: Update locale
run: |
bash tools/transifex/update_locale.sh

# Add the files, commit and push
git diff --staged --quiet || git commit -m "Update locale: commit ${{ env.GIT_HASH }}"
git restore . # Remove the unstaged changes before rebasing
git push
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Update Locale and Website
name: Website

on:
workflow_dispatch:
Expand All @@ -14,7 +14,7 @@ jobs:
release:
permissions:
contents: write # for Git to git push
name: Update Locale and Website
name: Update Website
runs-on: ubuntu-latest
if: ${{ github.repository_owner == 'pgRouting' }}

Expand Down Expand Up @@ -86,19 +86,6 @@ jobs:
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

- name: Update locale
if: github.ref == 'refs/heads/develop'
run: |
bash tools/transifex/update_locale.sh

# Add the files, commit and push
for line in `cat build/doc/locale_changes_po_pot.txt`; do git add "$line"; done
git diff --staged --quiet || git commit -m "Update locale: commit ${{ env.GIT_HASH }}"
git fetch origin develop
git restore . # Remove the unstaged changes before rebasing
git rebase origin/develop
git push origin develop


- name: Update Users Documentation
run: |
Expand Down
2 changes: 1 addition & 1 deletion doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ if (LOCALE)
"${PGR_DOCUMENTATION_SOURCE_DIR}"
"${CMAKE_SOURCE_DIR}/locale/pot"

COMMAND sphinx-intl update -d ${CMAKE_SOURCE_DIR}/locale -l en,es,ja > locale_changes.txt
COMMAND sphinx-intl update -d ${CMAKE_SOURCE_DIR}/locale -l en > locale_changes.txt
#COMMAND sphinx-intl update -p ${CMAKE_SOURCE_DIR}/locale/pot -d ${CMAKE_SOURCE_DIR}/locale --language=${SPHINXINTL_LANGUAGE}
#COMMAND sphinx-intl update-txconfig-resources --locale-dir ${CMAKE_SOURCE_DIR}/locale --pot-dir ${CMAKE_SOURCE_DIR}/locale/pot --transifex-project-name pgrouting

Expand Down
2 changes: 1 addition & 1 deletion doc/allpairs/pgr_floydWarshall.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Signatures
.. admonition:: \ \
:class: signatures

pgr floydWarshall(`Edges SQL`_, [``directed``])
pgr_floydWarshall(`Edges SQL`_, [``directed``])

| RETURNS SET OF |matrix-result|
| OR EMPTY SET
Expand Down
10 changes: 5 additions & 5 deletions doc/bellman_ford/pgr_edwardMoore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ One to One
.. admonition:: \ \
:class: signatures

| pgr_edwardMoore(`Edges SQL`_, **start vid**, **end vid**, [``directed``]);
| pgr_edwardMoore(`Edges SQL`_, **start vid**, **end vid**, [``directed``])

| RETURNS SET OF |result-1-1|
| OR EMPTY SET
Expand All @@ -132,7 +132,7 @@ One to Many
.. admonition:: \ \
:class: signatures

| pgr_edwardMoore(`Edges SQL`_, **start vid**, **end vids**, [``directed``]);
| pgr_edwardMoore(`Edges SQL`_, **start vid**, **end vids**, [``directed``])

| RETURNS SET OF |result-1-m|
| OR EMPTY SET
Expand All @@ -153,7 +153,7 @@ Many to One
.. admonition:: \ \
:class: signatures

| pgr_edwardMoore(`Edges SQL`_, **start vids**, **end vid**, [``directed``]);
| pgr_edwardMoore(`Edges SQL`_, **start vids**, **end vid**, [``directed``])

| RETURNS SET OF |result-m-1|
| OR EMPTY SET
Expand All @@ -174,7 +174,7 @@ Many to Many
.. admonition:: \ \
:class: signatures

| pgr_edwardMoore(`Edges SQL`_, **start vids**, **end vids**, [``directed``]);
| pgr_edwardMoore(`Edges SQL`_, **start vids**, **end vids**, [``directed``])

| RETURNS SET OF |short-generic-result|
| OR EMPTY SET
Expand All @@ -195,7 +195,7 @@ Combinations
.. admonition:: \ \
:class: signatures

| pgr_edwardMoore(`Edges SQL`_, `Combinations SQL`_, [``directed``]);
| pgr_edwardMoore(`Edges SQL`_, `Combinations SQL`_, [``directed``])

| RETURNS SET OF |short-generic-result|
| OR EMPTY SET
Expand Down
2 changes: 1 addition & 1 deletion doc/breadthFirstSearch/pgr_binaryBreadthFirstSearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Signatures
| pgr_binaryBreadthFirstSearch(`Edges SQL`_, **start vid**, **end vids**, [``directed``])
| pgr_binaryBreadthFirstSearch(`Edges SQL`_, **start vids**, **end vid**, [``directed``])
| pgr_binaryBreadthFirstSearch(`Edges SQL`_, **start vids**, **end vids**, [``directed``])
| pgr_binaryBreadthFirstSearch(`Edges SQL`_, **Combinations SQL**, [``directed``])
| pgr_binaryBreadthFirstSearch(`Edges SQL`_, `Combinations SQL`_, [``directed``])

| RETURNS SET OF |old-generic-result|
| OR EMPTY SET
Expand Down
2 changes: 1 addition & 1 deletion doc/dagShortestPath/pgr_dagShortestPath.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Combinations
.. admonition:: \ \
:class: signatures

| pgr_dagShortestPath(`Edges SQL`_, Combinations)
| pgr_dagShortestPath(`Edges SQL`_, `Combinations SQL`_)

| RETURNS SET OF |result-1-1|
| OR EMPTY SET
Expand Down
2 changes: 1 addition & 1 deletion doc/max_flow/flow-family.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Flow Functions General Information
.. characteristics_end


:doc:`pgr_maxFlow` is the maximum Flow and that maximum is guaranteed to be
:doc:`pgr_maxFlow` is the maximum Flow and that maximum is guaranteed to be
the same on the functions :doc:`pgr_pushRelabel`, :doc:`pgr_edmondsKarp`,
:doc:`pgr_boykovKolmogorov`, but the actual flow through each edge may vary.

Expand Down
20 changes: 10 additions & 10 deletions doc/withPoints/pgr_withPointsCost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@ Signatures
.. admonition:: \ \
:class: signatures

| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vid**, **end vid**, **[options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vid**, **end vids**, **[options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vids**, **end vid**, **[options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vids**, **end vids**, **[options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, `Combinations SQL`_, **[options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vid**, **end vid**, [**options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vid**, **end vids**, [**options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vids**, **end vid**, [**options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vids**, **end vids**, [**options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, `Combinations SQL`_, [**options**])
| **options:** ``[directed, driving_side]``

| RETURNS SET OF |matrix-pid|
Expand All @@ -130,7 +130,7 @@ One to One
.. admonition:: \ \
:class: signatures

| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vid**, **end vid**, **[options**])
| pgr_withPointsCost(`Edges SQL`_, 'Points SQL`_, **start vid**, **end vid**, [**options**])
| **options:** ``[directed, driving_side]``

| RETURNS SET OF |matrix-pid|
Expand All @@ -151,7 +151,7 @@ One to Many
.. admonition:: \ \
:class: signatures

| pgr_withPointsCost(`Edges SQL`_, `Points SQL`_, **start vid**, **end vids**, **[options**])
| pgr_withPointsCost(`Edges SQL`_, `Points SQL`_, **start vid**, **end vids**, [**options**])
| **options:** ``[directed, driving_side]``

| RETURNS SET OF |matrix-pid|
Expand All @@ -173,7 +173,7 @@ Many to One
.. admonition:: \ \
:class: signatures

| pgr_withPointsCost(`Edges SQL`_, `Points SQL`_, **start vids**, **end vid**, **[options**])
| pgr_withPointsCost(`Edges SQL`_, `Points SQL`_, **start vids**, **end vid**, [**options**])
| **options:** ``[directed, driving_side]``

| RETURNS SET OF |matrix-pid|
Expand All @@ -194,7 +194,7 @@ Many to Many
.. admonition:: \ \
:class: signatures

| pgr_withPointsCost(`Edges SQL`_, `Points SQL`_, **start vids**, **end vids**, **[options**])
| pgr_withPointsCost(`Edges SQL`_, `Points SQL`_, **start vids**, **end vids**, [**options**])
| **options:** ``[directed, driving_side]``

| RETURNS SET OF |matrix-pid|
Expand All @@ -216,7 +216,7 @@ Combinations
.. admonition:: \ \
:class: signatures

| pgr_withPointsCost(`Edges SQL`_, `Points SQL`_, `Combinations SQL`_, **[options**])
| pgr_withPointsCost(`Edges SQL`_, `Points SQL`_, `Combinations SQL`_, [**options**])
| **options:** ``[directed, driving_side]``

| RETURNS SET OF |matrix-pid|
Expand Down
2 changes: 1 addition & 1 deletion doc/withPoints/pgr_withPointsCostMatrix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Signatures
.. admonition:: \ \
:class: signatures

| pgr_withPointsCostMatrix(`Edges SQL`_, `Points SQL`_, **start vids**, **[options**])
| pgr_withPointsCostMatrix(`Edges SQL`_, `Points SQL`_, **start vids**, [**options**])
| **options:** ``[directed, driving_side]``

| RETURNS SET OF |matrix-result|
Expand Down
Loading