hans/Nominatim
1
0
Fork 1
mirror of https://github.com/osm-search/Nominatim.git synced 2026-02-16 15:47:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve wording

Browse Source 
as per review
This commit is contained in:
Sarah Hoffmann
2024-06-29 16:27:26 +02:00
parent fa1c402b47
commit ecf4693a79
8 changed files with 45 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/admin/Migration.md
View File

@@ -19,7 +19,7 @@ breaking changes. **Please read them before running the migration.**
### New structure for Python packages
The nominatim Python package has been split into nominatim-db and nominatim-api.
The nominatim Python package has been split into `nominatim-db` and `nominatim-api`.
Any imports need to be adapted accordingly.
If you are running the Python frontend, change the server module from

21
docs/develop/Development-Environment.md
View File

@@ -4,7 +4,7 @@ This chapter gives an overview how to set up Nominatim for development
and how to run tests.
!!! Important
This guide assumes that you develop under the latest version of Debain/Ubuntu.
This guide assumes you develop under the latest version of Debian/Ubuntu.
You can of course also use your favourite distribution. You just might have
to adapt the commands below slightly, in particular the commands for
installing additional software.
@@ -41,8 +41,8 @@ It has the following additional requirements:
For testing the Python search frontend, you need to install extra dependencies
depending on your choice of webserver framework:
* [httpx](https://www.python-httpx.org/) (starlette only)
* [asgi-lifespan](https://github.com/florimondmanca/asgi-lifespan) (starlette only)
* [httpx](https://www.python-httpx.org/) (Starlette only)
* [asgi-lifespan](https://github.com/florimondmanca/asgi-lifespan) (Starlette only)
The documentation is built with mkdocs:
@@ -106,12 +106,12 @@ be run in-place. The source directory features a special script
but executes against the code in the source tree. For example:
```
me@machine:~$ cd Nomiantim
me@machine:~Nomiantim$ ./nominatim-cli.py --version
me@machine:~$ cd Nominatim
me@machine:~Nominatim$ ./nominatim-cli.py --version
Nominatim version 4.4.99-1
```
Make sure you have activated the virtual environment that holds all
Make sure you have activated the virtual environment holding all
necessary dependencies.
## Executing Tests
@@ -124,7 +124,14 @@ To run all tests, run make from the source root:
make tests
```
There are also goals for executing parts of the test suite: mypy, lint, pytest, bdd.
There are also make targets for executing only parts of the test suite.
For example to run linting only use:
```sh
make lint
```
The possible testing targets are: mypy, lint, pytest, bdd.
For more information about the structure of the tests and how to change and
extend the test suite, see the [Testing chapter](Testing.md).

4
docs/library/Getting-Started.md
View File

@@ -18,12 +18,12 @@ To use the Nominatim library, you need access to a local Nominatim database.
Follow the [installation](../admin/Installation.md) and
[import](../admin/Import.md) instructions to set up your database.
The Nominatim frontend library is contained in the 'nominatim-api' package.
The Nominatim frontend library is contained in the Python package `nominatim-api`.
To install the package from the source tree directly, run:
pip install packaging/nominatim-api
Usually, you would want to run this in a virtual environment.
Usually you would want to run this in a virtual environment.
### A simple search example