[Draft] Standardize doc-strings - Githubissues

worldbank / GOSTnets

Convenience wrapper for networkx analysis using geospatial information, focusing on OSM

https://worldbank.github.io/GOSTnets/

MIT License

21 stars 15 forks source link

[Draft] Standardize doc-strings #59

Closed elbeejay closed 5 months ago

elbeejay commented 5 months ago

PR to close #44

This PR brings the doc-strings all into compliance with the ruff-linter and styles them in the NumPy format.

I believe more changes and refinements to the individual doc-strings will be required, and examples can always be added to the doc-strings. This will be an on-going process as tests are written etc.

Status of doc-string standardization per .py file:

[x] calculate_od_raw.py
[x] conversion_utils.py
[x] core.py
[x] fetch_od.py
[x] fetch_pois.py
[x] __init__.py
[x] load_osm.py
[x] network_clean.py
[x] optimization.py
[x] osm_parser.py
[x] utils/graphtool.py