drop amenity=waste_prposal and amenity=hunting_stand

[nominatim.git] / docs / develop / Development-Environment.md

diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md
index 20d024114107f97448acc8b2445056fcc1f0356f..a7c474e85bbc4248e44fb670317f3d3b657f3dcf 100644 (file)
--- a/docs/develop/Development-Environment.md
+++ b/docs/develop/Development-Environment.md
@@ -4,7 +4,7 @@ This chapter gives an overview how to set up Nominatim for development
 and how to run tests.
 
 !!! Important
 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.
     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:
 
 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:
 
 
 The documentation is built with mkdocs:
 


@@ -63,7 +63,7 @@ To set up the virtual environment with all necessary packages run:
 virtualenv ~/nominatim-dev-venv
 ~/nominatim-dev-venv/bin/pip install\
     psycopg2-binary psutil psycopg[binary] PyICU SQLAlchemy \
 virtualenv ~/nominatim-dev-venv
 ~/nominatim-dev-venv/bin/pip install\
     psycopg2-binary psutil psycopg[binary] PyICU SQLAlchemy \

-    python-dotenv jinja2 pyYAML datree \
+    python-dotenv jinja2 pyYAML datrie \

     behave mkdocs mkdocstrings pytest pytest-asyncio pylint \
     types-jinja2 types-markupsafe types-psutil types-psycopg2 \
     types-pygments types-pyyaml types-requests types-ujson \
     behave mkdocs mkdocstrings pytest pytest-asyncio pylint \
     types-jinja2 types-markupsafe types-psutil types-psycopg2 \
     types-pygments types-pyyaml types-requests types-ujson \


@@ -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:
 
 ```
 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
 ```
 
 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
 necessary dependencies.
 
 ## Executing Tests


@@ -124,7 +124,14 @@ To run all tests, run make from the source root:
 make tests
 ```
 
 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).
 
 For more information about the structure of the tests and how to change and
 extend the test suite, see the [Testing chapter](Testing.md).