Improve type hint documentation #240

merydian · 2024-04-16T14:07:20Z

Type hint documentation is improved in all relevant Python files.

merydian · 2024-04-16T14:13:36Z

Tagging @nyalldawson for some input please.

nyalldawson

Looking good! 👍👍

ORStools/ORStoolsPlugin.py

ORStools/common/client.py

ORStools/common/directions_core.py

ORStools/gui/ORStoolsDialogConfig.py

ORStools/proc/base_processing_algorithm.py

ORStools/proc/directions_lines_proc.py

ORStools/proc/directions_points_layers_proc.py

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

…qgis-plugin into type_hinting

ORStools/proc/directions_lines_proc.py

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

…qgis-plugin into type_hinting

ORStools/proc/isochrones_layer_proc.py

… proc

…proc

…s pr…

… proc

…layer proc

merydian added 22 commits April 16, 2024 11:50

docs: add type hints for ORStoolsDialog.py

5951934

docs: add type hints for ORStoolsDialogConfig.py

fb3da2c

docs: add type hints for client.py

5b64606

docs: add type hints for directions_core.py

ab0a90d

docs: add type hints for isochrones_core.py

44ed000

docs: add type hints for networkaccessmanager

3d9f025

docs: extend type hints for base_processing_algorithm.py

c79d8fc

docs: extend type hints for directions_lines_proc.py

c18f353

docs: extend type hints for directions_points_layer_proc.py

610ddf5

docs: extend type hints for directions_points_layers_proc.py

5be4f83

docs: extend type hints for isochrones_layer_proc.py

c773758

docs: extend type hints for matrix_proc.py

8f9df5e

docs: extend type hints for isochrones_point_proc.py

ee1809f

fix: import Dict

3ebb664

docs: extend type hints for config.py

66398d8

docs: add type hints for convert.py

5d422aa

docs: add type hints for logger.py

8451f35

docs: add type hints for maptools.py

51c0fc0

docs: add type hints for transform.py

3d32dcd

docs: add type hints for ORStoolsPlugin.py

19a0fb5

style: run ruff

7a193fb

docs: add to changelog

b495e26

nyalldawson reviewed Apr 16, 2024

View reviewed changes

merydian and others added 6 commits April 17, 2024 09:02

Update ORStools/ORStoolsPlugin.py

eeaa64f

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Update ORStools/common/directions_core.py

3744877

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Update ORStools/proc/base_processing_algorithm.py

f47db39

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Update ORStools/proc/directions_lines_proc.py

34383f2

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Update ORStools/common/directions_core.py

6010011

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Update ORStools/common/directions_core.py

2e93563

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

merydian added 4 commits April 17, 2024 09:10

docs: add missing type hints to ORStoolsDialogConfig.py

653d016

Merge branch 'type_hinting' of https://github.com/GIScience/orstools-…

86e3349

…qgis-plugin into type_hinting

fix: add missing import statements

2a34ab4

docs: update type hints in directions_points_layers_proc.py

8f28cad

merydian marked this pull request as ready for review April 17, 2024 07:45

merydian added 2 commits April 18, 2024 09:21

docs: set type hints of None values to optional

2a9248f

docs: add type hints for provider.py

290a1b4

merydian requested a review from koebi April 18, 2024 07:31

merydian added 2 commits May 10, 2024 07:50

fix: replace wrong type hint

edcd29f

fix: import typing Optional

074e247

koebi requested changes May 10, 2024

View reviewed changes

ORStools/proc/directions_lines_proc.py Outdated Show resolved Hide resolved

merydian and others added 2 commits May 10, 2024 13:53

Update ORStools/gui/ORStoolsDialog.py

01e2d18

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Merge branch 'type_hinting' of https://github.com/GIScience/orstools-…

a060502

…qgis-plugin into type_hinting

koebi reviewed May 10, 2024

View reviewed changes

ORStools/proc/isochrones_layer_proc.py Outdated Show resolved Hide resolved

koebi reviewed May 10, 2024

View reviewed changes

ORStools/proc/isochrones_layer_proc.py Outdated Show resolved Hide resolved

merydian and others added 9 commits May 13, 2024 03:22

docs: add type hints for process Algorithm method in isochrones layer…

b71aed9

… proc

docs: add type hints for process algorithm method in matrix proc

41e74e1

docs: add type hints for process Algorithm method in isochrones pint …

7bd401a

…proc

docs: add type hints for process Algorithm method in directions layer…

f6fe2e2

…s pr…

docs: add type hints for process Algorithm method in directions layer…

8dc3cef

… proc

docs: add type hints for process Algorithm method in directions lines…

e0ebea0

… proc

style: run ruff

8e9a571

docs: add type hints for post process Algorithm method in isochrones …

c8db1d3

…layer proc

Merge branch 'main' into type_hinting

d4e94cc

koebi approved these changes May 15, 2024

View reviewed changes

koebi merged commit 85ebed2 into main May 15, 2024
2 checks passed

koebi deleted the type_hinting branch May 15, 2024 14:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve type hint documentation #240

Improve type hint documentation #240

merydian commented Apr 16, 2024

merydian commented Apr 16, 2024

nyalldawson left a comment

Improve type hint documentation #240

Improve type hint documentation #240

Conversation

merydian commented Apr 16, 2024

merydian commented Apr 16, 2024

nyalldawson left a comment

Choose a reason for hiding this comment