search

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

Standardize doc-strings #44

Closed elbeejay closed 5 months ago

elbeejay commented 6 months ago

Most functions have doc-strings but they are not consistently formatted. Making them all consistent will improve the quality of the API documentation that will inevitably be auto-generated.

g4brielvs commented 6 months ago

@elbeejay Thanks! This is important and would increase the usability and consistency to this package. Additionally, it goes along with this discussion.

g4brielvs commented 5 months ago

@elbeejay Let's adopt Numpy's Style Guide. I've added ruff to pre-commit.