add type annotations to config module

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

diff --git a/docs/develop/Development-Environment.md b/docs/develop/Development-Environment.md
index f1610a49a479128cd1d28990fd6ade7a83cd35fb..9abfae3765d049a040b2e61e8fe08ed5538f59fa 100644 (file)
--- a/docs/develop/Development-Environment.md
+++ b/docs/develop/Development-Environment.md
@@ -30,9 +30,10 @@ unit tests (using PHPUnit for PHP code and pytest for Python code).
 It has the following additional requirements:
 
 * [behave test framework](https://behave.readthedocs.io) >= 1.2.6
 It has the following additional requirements:
 
 * [behave test framework](https://behave.readthedocs.io) >= 1.2.6

-* [phpunit](https://phpunit.de) >= 7.3
+* [phpunit](https://phpunit.de) (9.5 is known to work)

 * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
 * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)

-* [Pylint](https://pylint.org/) (2.6.0 is used for the CI)
+* [Pylint](https://pylint.org/) (CI always runs the latest version from pip)
+* [mypy](http://mypy-lang.org/) (plus typing information for external libs)

 * [pytest](https://pytest.org)
 
 The documentation is built with mkdocs:
 * [pytest](https://pytest.org)
 
 The documentation is built with mkdocs:


@@ -50,9 +51,10 @@ To install all necessary packages run:
 
 ```sh
 sudo apt install php-cgi phpunit php-codesniffer \
 
 ```sh
 sudo apt install php-cgi phpunit php-codesniffer \

-                 python3-pip python3-setuptools python3-dev pylint
+                 python3-pip python3-setuptools python3-dev

 
 

-pip3 install --user behave mkdocs mkdocstrings pytest
+pip3 install --user behave mkdocs mkdocstrings pytest \
+                    pylint mypy types-PyYAML types-jinja2

 ```
 
 The `mkdocs` executable will be located in `.local/bin`. You may have to add
 ```
 
 The `mkdocs` executable will be located in `.local/bin`. You may have to add


@@ -114,7 +116,7 @@ symlinks (see `CMakeLists.txt` for the exact steps).
 Now you can start webserver for local testing
 
 ```
 Now you can start webserver for local testing
 
 ```

-build> mame serve-doc
+build> make serve-doc

 [server:296] Serving on http://127.0.0.1:8000
 [handlers:62] Start watching changes
 ```
 [server:296] Serving on http://127.0.0.1:8000
 [handlers:62] Start watching changes
 ```