standardizing libpysal/weights docs #319

jGaboardi · 2020-07-14T14:29:25Z

This PR focuses on standardizing the libpysal/weights/* docs. See #290, #291, pysal/pysal#1174.

@sjsrey This is ready for review. It is 95% docstring standardization and 5% logic/code streaming. I have also added several functions to the api docs that had been left out earlier.

Shall I rebuild the actual doc html files or leave that until #290 is fully complete (or even next release)?

codecov · 2020-07-14T14:34:44Z

Codecov Report

Attention: Patch coverage is 69.58763% with 59 lines in your changes missing coverage. Please review.

Project coverage is 80.0%. Comparing base (8116db6) to head (c8c27b1).
Report is 794 commits behind head on main.

Files with missing lines	Patch %	Lines
libpysal/weights/util.py	66.0%	18 Missing ⚠️
libpysal/examples/base.py	30.0%	7 Missing ⚠️
libpysal/weights/weights.py	41.7%	7 Missing ⚠️
libpysal/weights/set_operations.py	62.5%	6 Missing ⚠️
libpysal/weights/adjtools.py	42.9%	4 Missing ⚠️
libpysal/weights/contiguity.py	73.3%	4 Missing ⚠️
libpysal/weights/spatial_lag.py	81.0%	4 Missing ⚠️
libpysal/weights/tests/test_distance.py	20.0%	4 Missing ⚠️
libpysal/weights/user.py	62.5%	3 Missing ⚠️
libpysal/examples/remotes.py	50.0%	1 Missing ⚠️
... and 1 more

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #319     +/-   ##
=======================================
+ Coverage   79.9%   80.0%   +0.1%     
=======================================
  Files        122     122             
  Lines      13225   13275     +50     
=======================================
+ Hits       10563   10614     +51     
+ Misses      2662    2661      -1

Files with missing lines	Coverage Δ
libpysal/cg/ops/_accessors.py	`80.0% <ø> (ø)`
libpysal/cg/ops/_shapely.py	`46.7% <ø> (ø)`
libpysal/cg/ops/tabular.py	`55.8% <ø> (ø)`
libpysal/cg/ops/tests/test_shapely.py	`28.8% <ø> (ø)`
libpysal/cg/polygonQuadTreeStructure.py	`85.7% <ø> (ø)`
libpysal/cg/rtree.py	`91.0% <ø> (ø)`
libpysal/cg/sphere.py	`72.6% <ø> (ø)`
libpysal/cg/standalone.py	`91.5% <ø> (ø)`
libpysal/cg/tests/test_geoJSON.py	`97.2% <ø> (ø)`
libpysal/cg/tests/test_locators.py	`96.2% <ø> (ø)`
... and 61 more

... and 1 file with indirect coverage changes

jGaboardi · 2020-11-22T22:24:14Z

@sjsrey All tests green again.

* TEST: add 3.11 and shapely_dev coverage * TEST: fix environment-file list * TEST: remove option numba * Update ci/311_shapely_dev.yaml Co-authored-by: Martin Fleischmann <[email protected]> --------- Co-authored-by: James Gaboardi <[email protected]> Co-authored-by: Martin Fleischmann <[email protected]>

martinfleis · 2023-03-06T10:57:18Z

I have no clue how to review this beast.

@jGaboardi I know it is late now but it would be better to split changes of docstrings from blackening the code to different PRs to know what to look for in the review. This is just impossible to review at this point.

Are there any changes to look for? Anything code-related that is not linting?

jGaboardi · 2023-03-06T11:51:07Z

I have no clue how to review this beast.

@jGaboardi I know it is late now but it would be better to split changes of docstrings from blackening the code to different PRs to know what to look for in the review. This is just impossible to review at this point.

Are there any changes to look for? Anything code-related that is not linting?

Yeah, this thing got a tad unwieldy over the years. I will looking into splitting it up as time permits. Probably start with black only in one PR then possibly even ruff (though I suspect ruff will catch some more-than-minor stuff in our code base here...). After that, I'll look back into the docstring standardization. Let's leave this PR open for now until all the constituent pieces are merged (or rejected).

martinfleis · 2023-03-06T13:05:33Z

Okay. Try to split black and ruff into different PRs. Ruff tends to involve code changes that need review while black can be merged directly.

jGaboardi · 2023-03-06T13:10:50Z

Yep, that was my plan. Maybe even ruff only 1 or 2 files at a time depending on the amount of changes made.

martinfleis · 2023-03-06T13:12:23Z

You will have to do ruff for the whole codebase to make it pass CI

jGaboardi · 2025-02-07T02:59:04Z

I think it prudent to close this out since we are gravitating towards graph.

jGaboardi added 3 commits July 13, 2020 20:10

remove empty libpysal/weights/test.py

a06e6f6

blackening test_NameSpace.py

8f03d7a

updating weights/_contW_lists.py and test file

159f254

jGaboardi added WIP Work in progress, do not merge. Discussion only. docs labels Jul 14, 2020

jGaboardi added this to the 4.4.0 milestone Jul 14, 2020

jGaboardi self-assigned this Jul 14, 2020

jGaboardi added 21 commits July 23, 2020 09:45

Merge branch 'master' into lps_weights_docs

c4c737c

doc review form adjtools.py & tests/test_adjlist.py

2295d58

add spacing between logic blocks in adjtools.py

da4174f

add spacing between logic blocks in adjtools.py [2]

39033d0

updating weights/contiguity.py & weights/tests/test_contiguity.py

67a89bf

Merge branch 'master' into lps_weights_docs

6923d4b

updating weights/tests/test_*

6123e9a

update libpysal/weights/user.py

dafea7f

update libpysal/weights/spatial_lag.py

bdca6df

Merge remote-tracking branch 'upstream/master' into lps_weights_docs

2dd212a

Merge remote-tracking branch 'upstream/master' into lps_weights_docs

07c88b8

intermediary commit for weights/distance.py

3187326

Merge branch 'master' into lps_weights_docs

6fe3388

intermediary commit for weights/distance.py [1]

7561db0

completing update for weights/distance.py

1740512

updating typos in weights/distance.py and weights/contiguity.py

22cbc8a

updating typos in weights/_contW_lists.py and weights/adjtools.py

12b66de

updating weights/spintW.py

154216e

updating weights/set_operations.py

88035fb

various updats for weights/{distance, weights, spintW}.py

c15d215

fixing more various typos, etc.

ae5419a

jGaboardi added 6 commits October 27, 2020 14:18

Merge branch 'master' into lps_weights_docs

e0c6952

Update .pre-commit-config.yaml

b8b207d

merge master

b8124f8

merge master

83453fd

Merge branch 'master' into lps_weights_docs

f5dc67f

Merge branch 'master' into lps_weights_docs

5523c06

jGaboardi and others added 11 commits November 22, 2020 18:13

Merge branch 'master' into lps_weights_docs

04a4ddd

Merge branch 'master' into lps_weights_docs

6ef544c

Merge branch 'master' into lps_weights_docs

21356a5

add missing kwarg to fuzzy_contiguity

9d73b08

Merge branch 'master' into lps_weights_docs

9b22c7e

merge master

66d3dce

merge master

06f3e96

merge master

2768d85

merge main

31ac0c7

merge main

2000cc3

jGaboardi force-pushed the lps_weights_docs branch from 7ebc25e to 2000cc3 Compare February 27, 2023 03:06

jGaboardi changed the base branch from master to main February 27, 2023 03:07

jGaboardi requested review from knaaptime and martinfleis February 27, 2023 05:15

remove 311_shapely_dev.yaml

c8c27b1

jGaboardi closed this Feb 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

standardizing libpysal/weights docs #319

standardizing libpysal/weights docs #319

jGaboardi commented Jul 14, 2020 •

edited

Loading

codecov bot commented Jul 14, 2020 •

edited

Loading

jGaboardi commented Nov 22, 2020

martinfleis commented Mar 6, 2023

jGaboardi commented Mar 6, 2023

martinfleis commented Mar 6, 2023

jGaboardi commented Mar 6, 2023

martinfleis commented Mar 6, 2023

jGaboardi commented Feb 7, 2025

standardizing libpysal/weights docs #319

standardizing libpysal/weights docs #319

Conversation

jGaboardi commented Jul 14, 2020 • edited Loading

codecov bot commented Jul 14, 2020 • edited Loading

Codecov Report

jGaboardi commented Nov 22, 2020

martinfleis commented Mar 6, 2023

jGaboardi commented Mar 6, 2023

martinfleis commented Mar 6, 2023

jGaboardi commented Mar 6, 2023

martinfleis commented Mar 6, 2023

jGaboardi commented Feb 7, 2025

jGaboardi commented Jul 14, 2020 •

edited

Loading

codecov bot commented Jul 14, 2020 •

edited

Loading