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

Add examples section to locate module #198

Merged
merged 2 commits into from
Sep 26, 2021

Conversation

gegen07
Copy link
Member

@gegen07 gegen07 commented Sep 24, 2021

Closes #190.

@gegen07 gegen07 added the docs label Sep 24, 2021
@codecov
Copy link

codecov bot commented Sep 24, 2021

Codecov Report

Merging #198 (db04d21) into main (06ae670) will increase coverage by 0.2%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            main    #198     +/-   ##
=======================================
+ Coverage   65.1%   65.3%   +0.2%     
=======================================
  Files         23      23             
  Lines       2458    2458             
  Branches     494     494             
=======================================
+ Hits        1600    1605      +5     
+ Misses       786     777      -9     
- Partials      72      76      +4     
Impacted Files Coverage Δ
spopt/locate/base.py 97.9% <ø> (ø)
spopt/locate/coverage.py 100.0% <ø> (ø)
spopt/locate/p_center.py 100.0% <ø> (ø)
spopt/locate/p_median.py 100.0% <ø> (ø)
spopt/locate/util.py 100.0% <ø> (ø)
spopt/_version.py 33.8% <0.0%> (+1.5%) ⬆️

>>> from spopt.locate.coverage import LSCP
>>> from spopt.locate.util import simulated_geo_points
>>> import pulp
>>> import spaghetti
Copy link
Member

Choose a reason for hiding this comment

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

If we are going to have spaghetti in the doc string examples, then we should probably also have in requirements.txt.

Copy link
Member

@jGaboardi jGaboardi left a comment

Choose a reason for hiding this comment

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

Overall, great job @gegen07. One small addition needed, then I think we can merge.

@gegen07 gegen07 force-pushed the issue-190-add-locate-docs branch from 1c67f77 to db04d21 Compare September 26, 2021 19:26
@jGaboardi jGaboardi merged commit d08de02 into pysal:main Sep 26, 2021
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.

update locate docs
2 participants