search

pysal / momepy

Urban Morphology Measuring Toolkit
https://docs.momepy.org
BSD 3-Clause "New" or "Revised" License
465 stars 56 forks source link

DOC: rework API docs around the new functional stuff #597

Closed martinfleis closed 1 month ago

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.0%. Comparing base (4037c70) to head (d1bc032). Report is 37 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/pysal/momepy/pull/597/graphs/tree.svg?width=650&height=150&src=pr&token=VNn0WR5JWT&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal)](https://app.codecov.io/gh/pysal/momepy/pull/597?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal) ```diff @@ Coverage Diff @@ ## main #597 +/- ## ======================================= + Coverage 97.4% 98.0% +0.6% ======================================= Files 26 37 +11 Lines 4328 6026 +1698 ======================================= + Hits 4214 5904 +1690 - Misses 114 122 +8 ``` | [Files](https://app.codecov.io/gh/pysal/momepy/pull/597?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal) | Coverage Δ | | |---|---|---| | [momepy/coins.py](https://app.codecov.io/gh/pysal/momepy/pull/597?src=pr&el=tree&filepath=momepy%2Fcoins.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal#diff-bW9tZXB5L2NvaW5zLnB5) | `95.3% <ø> (ø)` | | | [momepy/functional/\_diversity.py](https://app.codecov.io/gh/pysal/momepy/pull/597?src=pr&el=tree&filepath=momepy%2Ffunctional%2F_diversity.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal#diff-bW9tZXB5L2Z1bmN0aW9uYWwvX2RpdmVyc2l0eS5weQ==) | `96.4% <ø> (ø)` | | | [momepy/functional/\_elements.py](https://app.codecov.io/gh/pysal/momepy/pull/597?src=pr&el=tree&filepath=momepy%2Ffunctional%2F_elements.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal#diff-bW9tZXB5L2Z1bmN0aW9uYWwvX2VsZW1lbnRzLnB5) | `99.0% <ø> (ø)` | | | [momepy/preprocessing.py](https://app.codecov.io/gh/pysal/momepy/pull/597?src=pr&el=tree&filepath=momepy%2Fpreprocessing.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal#diff-bW9tZXB5L3ByZXByb2Nlc3NpbmcucHk=) | `93.4% <ø> (+0.1%)` | :arrow_up: |
martinfleis commented 1 month ago

Here's the outcome https://momepy--597.org.readthedocs.build/en/597/api.html

jGaboardi commented 1 month ago

I gave the rendered docs a once over -- looking good.