pysal / libpysal

Core components of Python Spatial Analysis Library
http://pysal.org/libpysal
Other
249 stars 79 forks source link

W to g guide #733

Open sjsrey opened 1 week ago

sjsrey commented 1 week ago

This is a start towards addressing #712. Seeking feedback and discussion.

It will add a note to the index page:

image

This also adds a dynamically generated rst file that will report on the members for W and Graph, which is the target of the note.

image

In addition, I will add a notebook that builds on the suggestions in #712 to have more of a user facing orientation.

This is intended to be dynamic and assist us as we fully build out the Graph moving forward.

Once we are done with the transition, we can remove this dynamically generated rst file, if so desired.

codecov[bot] commented 1 week ago

Codecov Report

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

Project coverage is 85.2%. Comparing base (bcabdbc) to head (3c938c1). Report is 39 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/pysal/libpysal/pull/733/graphs/tree.svg?width=650&height=150&src=pr&token=wgnkG5Rj0J&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal)](https://app.codecov.io/gh/pysal/libpysal/pull/733?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal) ```diff @@ Coverage Diff @@ ## main #733 +/- ## ======================================= + Coverage 85.0% 85.2% +0.2% ======================================= Files 141 145 +4 Lines 15203 15639 +436 ======================================= + Hits 12924 13323 +399 - Misses 2279 2316 +37 ``` [see 22 files with indirect coverage changes](https://app.codecov.io/gh/pysal/libpysal/pull/733/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal)
knaaptime commented 1 week ago

sweet

martinfleis commented 5 days ago

I like that automatic comparison but in some cases, it may be worth adding a note explaining why there's no match and what is recommended to do instead. E.g Graph does not have islands but has isolates instead etc.

I also suppose that merge shall wait until the notebook is complete, right?

sjsrey commented 5 days ago

I like that automatic comparison but in some cases, it may be worth adding a note explaining why there's no match and what is recommended to do instead. E.g Graph does not have islands but has isolates instead etc.

Yes, this was intended to identify all the cases we need to surface in the recommendations. I wasn't sure if we should put the recommendations in these tables, or treat them in the migration notebook where we can have a bit more narrative for the user.

I also suppose that merge shall wait until the notebook is complete, right?

Definitely.

martinfleis commented 5 days ago

treat them in the migration notebook where we can have a bit more narrative for the user.

That may be better. We just need to make a link to the notebook clear and visible from the RST with the tables.