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.

Sign up for GitHub

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

Jump to bottom

DOC: Fix a couple Sphinx warnings #728

Merged
merged 1 commit into from
Jun 26, 2024
Merged

DOC: Fix a couple Sphinx warnings #728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 14 additions & 11 deletions libpysal/graph/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1151,17 +1151,20 @@ def build_triangulation(
Clipping method when ``method="voronoi"``. Ignored otherwise.
Default is ``'bounding_box'``. Options are as follows.

* ``None`` -- No clip is applied. Voronoi cells may be arbitrarily
larger that the source map. Note that this may lead to cells that are many
orders of magnitude larger in extent than the original map. Not recommended.
* ``'bounding_box'`` -- Clip the voronoi cells to the
bounding box of the input points.
* ``'convex_hull'`` -- Clip the voronoi cells to the convex hull of
the input points.
* ``'alpha_shape'`` -- Clip the voronoi cells to the tightest hull that
contains all points (e.g. the smallest alpha shape, using
:func:`libpysal.cg.alpha_shape_auto`).
* ``shapely.Polygon`` -- Clip to an arbitrary Polygon.
``None``
No clip is applied. Voronoi cells may be arbitrarily larger that the
source map. Note that this may lead to cells that are many orders of
magnitude larger in extent than the original map. Not recommended.
``'bounding_box'``
Clip the voronoi cells to the bounding box of the input points.
``'convex_hull'``
Clip the voronoi cells to the convex hull of the input points.
``'alpha_shape'``
Clip the voronoi cells to the tightest hull that contains all points
(e.g. the smallest alpha shape, using
:func:`libpysal.cg.alpha_shape_auto`).
``shapely.Polygon``
Clip to an arbitrary Polygon.

rook : bool, optional
Contiguity method when ``method="voronoi"``. Ignored otherwise.
Expand Down
7 changes: 4 additions & 3 deletions libpysal/weights/contiguity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,8 +404,9 @@ def from_shapefile(cls, filepath, idVariable=None, full=False, **kwargs):
@classmethod
def from_iterable(cls, iterable, sparse=False, **kwargs):
"""
Construct a weights object from a collection of arbitrary polygons. This
will cast the polygons to PySAL polygons, then build the W.
Construct a weights object from a collection of arbitrary polygons.

This will cast the polygons to PySAL polygons, then build the W.

Parameters
----------
Expand All @@ -417,7 +418,7 @@ def from_iterable(cls, iterable, sparse=False, **kwargs):
optional arguments for :class:`pysal.weights.W`

See Also
---------
--------
:class:`libpysal.weights.weights.W`
:class:`libpysal.weights.contiguiyt.Queen`
"""
Expand Down