pysal / spreg

Spatial econometric regression in Python
https://pysal.org/spreg/
Other
66 stars 23 forks source link

revisit docstring and doctest updates #109

Open jGaboardi opened 1 year ago

jGaboardi commented 1 year ago

@pedrovma This PR demonstrates the docstring + doctests updates/standardizations that are in need of attentions (xref #57, #62). Before I spend more time on this, I would like to know the level of desire and likelihood of merge. This PR is an example on spreg/sur_error.py only. Let me know what you think.

codecov[bot] commented 1 year ago

Codecov Report

Merging #109 (ab617f5) into main (c0ead26) will decrease coverage by 0.0%. The diff coverage is 92.7%.

Impacted file tree graph

@@           Coverage Diff           @@
##            main    #109     +/-   ##
=======================================
- Coverage   69.1%   69.1%   -0.0%     
=======================================
  Files         40      40             
  Lines       8723    8721      -2     
  Branches    1253    1253             
=======================================
- Hits        6024    6022      -2     
  Misses      2319    2319             
  Partials     380     380             
Files Coverage Δ
spreg/sur_error.py 76.6% <92.7%> (-0.1%) :arrow_down:
jGaboardi commented 11 months ago

@pedrovma, Let me know if this of interest. If it is not something you are interested in then there's no hard feelings from me. We can close out the PR if that's the case.