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

polish up docstrings, etc. in skater.py #335

Merged
merged 10 commits into from
Jan 9, 2023

Conversation

jGaboardi
Copy link
Member

@jGaboardi jGaboardi commented Jan 9, 2023

This PR:

  • polish up docstrings in region/skater.py
  • converts formatted string to f-strings in region/skater.py
  • makes a couple formatting correction in region/base.py
  • cleans up references in docs/_static/references.bib
  • change a raw Exception to a ValueError in region/skater.py

xref #173, #280, #331

@jGaboardi jGaboardi self-assigned this Jan 9, 2023
@jGaboardi jGaboardi added the docs label Jan 9, 2023
@jGaboardi jGaboardi requested a review from knaaptime January 9, 2023 17:39
@jGaboardi jGaboardi mentioned this pull request Jan 9, 2023
4 tasks
@codecov
Copy link

codecov bot commented Jan 9, 2023

Codecov Report

Merging #335 (179607d) into main (f2f54ef) will not change coverage.
The diff coverage is 88.9%.

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #335   +/-   ##
=====================================
  Coverage   74.0%   74.0%           
=====================================
  Files         23      23           
  Lines       2477    2477           
  Branches     513     513           
=====================================
  Hits        1833    1833           
  Misses       580     580           
  Partials      64      64           
Impacted Files Coverage Δ
spopt/region/base.py 97.6% <ø> (ø)
spopt/region/skater.py 82.7% <88.9%> (ø)

@jGaboardi
Copy link
Member Author

@knaaptime Thanks for the review!

@jGaboardi jGaboardi merged commit 3473ffd into pysal:main Jan 9, 2023
@jGaboardi jGaboardi deleted the region_docwork_2 branch January 9, 2023 17:47
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.

2 participants