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

DOC: Fix a couple Sphinx warnings #728

Merged
merged 1 commit into from
Jun 26, 2024
Merged

Conversation

QuLogic
Copy link
Contributor

@QuLogic QuLogic commented Jun 26, 2024

  1. 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. This pull request is directed to the pysal/master branch.
  3. This pull introduces new functionality covered by
    docstrings and
    unittests?
  4. [n/a] You have assigned a
    reviewer
    and added relevant labels
  5. 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.

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.
```
Copy link

codecov bot commented Jun 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

@@           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 Coverage Δ
libpysal/graph/base.py 96.8% <ø> (ø)
libpysal/weights/contiguity.py 78.6% <ø> (ø)

... and 4 files with indirect coverage changes

Copy link
Member

@martinfleis martinfleis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jGaboardi jGaboardi requested a review from knaaptime June 26, 2024 12:30
@jGaboardi jGaboardi added the docs label Jun 26, 2024
@martinfleis martinfleis merged commit 4fb699f into pysal:main Jun 26, 2024
11 checks passed
@QuLogic QuLogic deleted the doc-warnings branch June 26, 2024 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants