pysal / libpysal

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

DOC: Fix a couple Sphinx warnings #728

Closed QuLogic closed 1 week ago

QuLogic commented 1 week ago
  1. [x] You have run tests on this submission locally using pytest on your changes. Continuous integration will be run on all PRs with GitHub Actions, but it is good practice to test changes locally prior to a making a PR.
  2. [x] This pull request is directed to the pysal/master branch.
  3. [x] This pull introduces new functionality covered by docstrings and unittests?
  4. [n/a] You have assigned a reviewer and added relevant labels
  5. [x] The justification for this PR is:

This fixes the following warnings:

/usr/lib/python3.12/site-packages/numpydoc/docscrape.py:455: UserWarning:
potentially wrong underline length...
See Also
--------- in
Construct a weights object from a collection of arbitrary polygons. This
will cast the polygons to PySAL polygons, then build the W....
in the docstring of from_iterable in libpysal/weights/contiguity.py.

libpysal/graph/base.py:docstring of libpysal.graph.base.Graph.build_triangulation:36: WARNING: Bullet list ends without a blank line; unexpected unindent.
codecov[bot] commented 1 week ago

Codecov Report

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

Project coverage is 85.1%. Comparing base (e82d1be) to head (69190d2). Report is 3 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/pysal/libpysal/pull/728/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/728?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal) ```diff @@ Coverage Diff @@ ## main #728 +/- ## ======================================= + Coverage 83.9% 85.1% +1.2% ======================================= Files 145 145 Lines 15583 15585 +2 ======================================= + Hits 13077 13270 +193 + Misses 2506 2315 -191 ``` | [Files](https://app.codecov.io/gh/pysal/libpysal/pull/728?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal) | Coverage Δ | | |---|---|---| | [libpysal/graph/base.py](https://app.codecov.io/gh/pysal/libpysal/pull/728?src=pr&el=tree&filepath=libpysal%2Fgraph%2Fbase.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal#diff-bGlicHlzYWwvZ3JhcGgvYmFzZS5weQ==) | `96.8% <ø> (ø)` | | | [libpysal/weights/contiguity.py](https://app.codecov.io/gh/pysal/libpysal/pull/728?src=pr&el=tree&filepath=libpysal%2Fweights%2Fcontiguity.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal#diff-bGlicHlzYWwvd2VpZ2h0cy9jb250aWd1aXR5LnB5) | `78.6% <ø> (ø)` | | ... and [4 files with indirect coverage changes](https://app.codecov.io/gh/pysal/libpysal/pull/728/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pysal)