Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

standardizing libpysal/weights docs #319

Open
wants to merge 58 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
a06e6f6
remove empty libpysal/weights/test.py
jGaboardi Jul 14, 2020
8f03d7a
blackening test_NameSpace.py
jGaboardi Jul 14, 2020
159f254
updating weights/_contW_lists.py and test file
jGaboardi Jul 14, 2020
c4c737c
Merge branch 'master' into lps_weights_docs
jGaboardi Jul 23, 2020
2295d58
doc review form adjtools.py & tests/test_adjlist.py
jGaboardi Aug 11, 2020
da4174f
add spacing between logic blocks in adjtools.py
jGaboardi Aug 11, 2020
39033d0
add spacing between logic blocks in adjtools.py [2]
jGaboardi Aug 11, 2020
67a89bf
updating weights/contiguity.py & weights/tests/test_contiguity.py
jGaboardi Aug 14, 2020
6923d4b
Merge branch 'master' into lps_weights_docs
jGaboardi Aug 14, 2020
6123e9a
updating weights/tests/test_*
jGaboardi Aug 15, 2020
dafea7f
update libpysal/weights/user.py
jGaboardi Aug 16, 2020
bdca6df
update libpysal/weights/spatial_lag.py
jGaboardi Aug 16, 2020
2dd212a
Merge remote-tracking branch 'upstream/master' into lps_weights_docs
jGaboardi Aug 16, 2020
07c88b8
Merge remote-tracking branch 'upstream/master' into lps_weights_docs
jGaboardi Aug 17, 2020
3187326
intermediary commit for weights/distance.py
jGaboardi Aug 17, 2020
6fe3388
Merge branch 'master' into lps_weights_docs
jGaboardi Aug 18, 2020
7561db0
intermediary commit for weights/distance.py [1]
jGaboardi Aug 20, 2020
1740512
completing update for weights/distance.py
jGaboardi Aug 21, 2020
22cbc8a
updating typos in weights/distance.py and weights/contiguity.py
jGaboardi Aug 21, 2020
12b66de
updating typos in weights/_contW_lists.py and weights/adjtools.py
jGaboardi Aug 21, 2020
154216e
updating weights/spintW.py
jGaboardi Aug 21, 2020
88035fb
updating weights/set_operations.py
jGaboardi Aug 22, 2020
c15d215
various updats for weights/{distance, weights, spintW}.py
jGaboardi Aug 23, 2020
ae5419a
fixing more various typos, etc.
jGaboardi Aug 23, 2020
bc1d4bb
updating weights/weights.py and other typos, etc.
jGaboardi Aug 24, 2020
e20bc42
intermediary commit for weights/util.py
jGaboardi Aug 24, 2020
3244f30
correction to weights/adjtools.py
jGaboardi Aug 24, 2020
1417ae7
completing docstrings for weight/util.py, etc.
jGaboardi Aug 26, 2020
0af1af1
adding undocumented functions to api.rst
jGaboardi Aug 26, 2020
4d76107
blackening cg/tests/*
jGaboardi Aug 26, 2020
c6007d5
blackening cg/ops/tests/test_*
jGaboardi Aug 26, 2020
0caa78d
minor updates to examples/*.py stuff
jGaboardi Aug 26, 2020
b90b118
latex update to weights/spintW.py
jGaboardi Aug 26, 2020
cb94b32
merging in master
jGaboardi Sep 15, 2020
e9231e3
Merge branch 'master' into lps_weights_docs
jGaboardi Oct 1, 2020
331021d
Merge branch 'master' into lps_weights_docs
jGaboardi Oct 1, 2020
c058a3f
merge in master
jGaboardi Oct 5, 2020
fdd68b5
Merge branch 'master' into lps_weights_docs
jGaboardi Oct 19, 2020
0fe33ff
resolving conflicts w/main
jGaboardi Oct 25, 2020
57721a9
merge in upstream/master
jGaboardi Oct 27, 2020
e0c6952
Merge branch 'master' into lps_weights_docs
jGaboardi Oct 27, 2020
b8b207d
Update .pre-commit-config.yaml
jGaboardi Oct 27, 2020
b8124f8
merge master
jGaboardi Nov 4, 2020
83453fd
merge master
jGaboardi Nov 4, 2020
f5dc67f
Merge branch 'master' into lps_weights_docs
jGaboardi Nov 22, 2020
5523c06
Merge branch 'master' into lps_weights_docs
jGaboardi Nov 22, 2020
04a4ddd
Merge branch 'master' into lps_weights_docs
jGaboardi Nov 22, 2020
6ef544c
Merge branch 'master' into lps_weights_docs
jGaboardi Dec 10, 2020
21356a5
Merge branch 'master' into lps_weights_docs
jGaboardi Dec 10, 2020
9d73b08
add missing kwarg to fuzzy_contiguity
jGaboardi Dec 10, 2020
9b22c7e
Merge branch 'master' into lps_weights_docs
jGaboardi Dec 20, 2020
66d3dce
merge master
jGaboardi Jan 2, 2021
06f3e96
merge master
jGaboardi Jan 2, 2021
2768d85
merge master
jGaboardi Jun 13, 2021
ded03e3
TEST: 3.11 dev coverage (#516)
sjsrey Feb 26, 2023
31ac0c7
merge main
jGaboardi Feb 27, 2023
2000cc3
merge main
jGaboardi Feb 27, 2023
c8c27b1
remove 311_shapely_dev.yaml
jGaboardi Feb 27, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion libpysal/cg/ops/_accessors.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ def get_attr(df, geom_col="geometry", inplace=False, attr=None):
return outval



_doc_template = """
Tabular accessor to grab a geometric object's {n} attribute.

Expand Down
12 changes: 6 additions & 6 deletions libpysal/cg/ops/_shapely.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,10 @@ def cascaded_union(df, geom_col="geometry", **groupby_kws):

See Also
--------

pysal.shapely_ext.cascaded_union
pandas.DataFrame.groupby

"""

by = groupby_kws.pop("by", None)
Expand Down Expand Up @@ -159,10 +159,10 @@ def unary_union(df, geom_col="geometry", **groupby_kws):

See Also
--------

pysal.shapely_ext.unary_union
pandas.DataFrame.groupby

"""

by = groupby_kws.pop("by", None)
Expand Down Expand Up @@ -208,10 +208,10 @@ def cascaded_intersection(df, geom_col="geometry", **groupby_kws):

See Also
--------

pysal.shapely_ext.cascaded_intersection
pandas.DataFrame.groupby

"""

by = groupby_kws.pop("by", None)
Expand Down
8 changes: 4 additions & 4 deletions libpysal/cg/ops/tabular.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ def spatial_join(
the suffix to apply to overlapping column names from ``df1``.;
and (4) ``'rsuffix'`` defaults to ``right'``),
the suffix to apply to overlapping column names from ``df2``.

Returns
-------
df : pandas.DataFrame
A pandas.DataFrame with a new set of polygons
and attributes resulting from the overlay.

"""

import geopandas as gpd
Expand Down Expand Up @@ -103,13 +103,13 @@ def spatial_overlay(
Default is ``'geometry'``.
**kwargs : dict
Optional keyword arguments passed in ``geopandas.tools.overlay``.

Returns
-------
df : pandas.DataFrame
A pandas.DataFrame with a new set of polygons
and attributes resulting from the overlay.

"""

import geopandas as gpd
Expand Down
9 changes: 4 additions & 5 deletions libpysal/cg/ops/tests/test_shapely.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,20 @@ def test_has_z(self):
def test_is_empty(self):
"""
PySAL doesn't really support empty shapes. Like, the following errors out:

```
ps.cg.Polygon([[]])
```

and you can make it work by:

```
ps.cg.Polygon([[()]])
```

but that won't convert over to shapely.

So, we're only testing the negative here.

"""
for df in self.dframes:
self.compare("is_empty", df)
Expand Down
2 changes: 1 addition & 1 deletion libpysal/cg/polygonQuadTreeStructure.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def __init__(self, level, min_x, min_y, length_x, length_y, arcs, status):

@property
def rings(self):
""" the list of rings which are formed by the intersection of this cell and the arcs pass them
"""the list of rings which are formed by the intersection of this cell and the arcs pass them

Returns
-------
Expand Down
Loading