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

revisit docstring and doctest updates #109

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jGaboardi
Copy link
Member

@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
Copy link

codecov bot commented Nov 1, 2022

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%) ⬇️

@jGaboardi
Copy link
Member Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant