From b7eea4d53ae1c87568161ff70d4f02aa33e18332 Mon Sep 17 00:00:00 2001 From: marc tobias Date: Mon, 4 Mar 2024 00:17:57 +0100 Subject: [PATCH] Github Actions: add codespell linter, warn only --- .codespellrc | 7 +++++++ .github/workflows/ci-tests.yml | 7 +++++++ nominatim/api/search/db_search_builder.py | 2 +- nominatim/db/connection.py | 2 +- settings/env.defaults | 10 +++++----- 5 files changed, 21 insertions(+), 7 deletions(-) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 00000000..332bce52 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,7 @@ +# https://github.com/codespell-project/codespell + +[codespell] +skip = ./man/nominatim.1,data,./docs/styles.css,lib-php,module,munin,osm2pgsql,./test,./settings/*.lua,./settings/*.yaml,./settings/**/*.yaml,./settings/icu-rules,./nominatim/tokenizer/token_analysis/config_variants.py +# Need to be lowercase in the list +# Unter = Unter den Linden (an example address) +ignore-words-list = inout,unter diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml index 910114d7..d1079375 100644 --- a/.github/workflows/ci-tests.yml +++ b/.github/workflows/ci-tests.yml @@ -386,3 +386,10 @@ jobs: - name: Check full import run: nominatim admin --check-database + + codespell: + runs-on: ubuntu-latest + steps: + - uses: codespell-project/actions-codespell@v2 + with: + only_warn: 1 diff --git a/nominatim/api/search/db_search_builder.py b/nominatim/api/search/db_search_builder.py index f2b653f2..ef7a66b8 100644 --- a/nominatim/api/search/db_search_builder.py +++ b/nominatim/api/search/db_search_builder.py @@ -5,7 +5,7 @@ # Copyright (C) 2023 by the Nominatim developer community. # For a full list of authors see the git log. """ -Convertion from token assignment to an abstract DB search. +Conversion from token assignment to an abstract DB search. """ from typing import Optional, List, Tuple, Iterator, Dict import heapq diff --git a/nominatim/db/connection.py b/nominatim/db/connection.py index 82801ae7..d6860836 100644 --- a/nominatim/db/connection.py +++ b/nominatim/db/connection.py @@ -239,7 +239,7 @@ _PG_CONNECTION_STRINGS = { def get_pg_env(dsn: str, base_env: Optional[SysEnv] = None) -> Dict[str, str]: """ Return a copy of `base_env` with the environment variables for - PostgresSQL set up from the given database connection string. + PostgreSQL set up from the given database connection string. If `base_env` is None, then the OS environment is used as a base environment. """ diff --git a/settings/env.defaults b/settings/env.defaults index 64a160c7..f4c33e77 100644 --- a/settings/env.defaults +++ b/settings/env.defaults @@ -123,9 +123,9 @@ NOMINATIM_TABLESPACE_ADDRESS_DATA= # Tablespace for indexes used during address computation. Used for import and update only. NOMINATIM_TABLESPACE_ADDRESS_INDEX= -# Tablespace for tables for auxilary data, e.g. TIGER data, postcodes. +# Tablespace for tables for auxiliary data, e.g. TIGER data, postcodes. NOMINATIM_TABLESPACE_AUX_DATA= -# Tablespace for indexes for auxilary data, e.g. TIGER data, postcodes. +# Tablespace for indexes for auxiliary data, e.g. TIGER data, postcodes. NOMINATIM_TABLESPACE_AUX_INDEX= @@ -183,7 +183,7 @@ NOMINATIM_SEARCH_BATCH_MODE=no # Threshold for searches by name only. # Threshold where the lookup strategy in the database is switched. If there -# are less occurences of a tem than given, the search does the lookup only +# are less occurrences of a tem than given, the search does the lookup only # against the name, otherwise it uses indexes for name and address. NOMINATIM_SEARCH_NAME_ONLY_THRESHOLD=500 @@ -210,8 +210,8 @@ NOMINATIM_API_POOL_SIZE=10 NOMINATIM_QUERY_TIMEOUT=10 # Maximum time a single request is allowed to take. When the timeout is -# exceeeded, the available results are returned. -# When empty, then timouts are disabled. +# exceeded, the available results are returned. +# When empty, then timeouts are disabled. NOMINATIM_REQUEST_TIMEOUT=60 # Search elements just within countries -- 2.39.5