@@ -34,13 +34,13 @@ Alternatively you can directly call individual test modules. For instance:
`python -m pytest -s tests/overpy_series_test.py`
# General Coding Guidelines
# Coding Guidlines
**General**
* Use [type hints](https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html) for parameters and return values for each function you implement
* Each module should have basic [unit tests](https://realpython.com/python-testing/) so that we can catch coding errors before we push changes
* Each function and class should include a [docstring](https://realpython.com/documenting-python-code/#documenting-your-python-code-base-using-docstrings)
# Good Practices
**Good Practices**
* Common pittfalls --- for instance wrong EPSG --- should be handled via [warnings](https://docs.python.org/3/library/warnings.html) or exceptions so that errors are not introduced silently
* Whenever we are dealing with coordinates, we try to use [geopandas.GeoSeries](https://geopandas.org/reference/geopandas.GeoSeries.html) so that the projection is handled explicitly
