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

API: Rename maxiter and maxtries to max_iter and max_tries #230

Merged
merged 4 commits into from Jul 9, 2021

Conversation

scottclowe
Copy link
Member

In keeping with python style guides and the max_iter argument used in sklearn e.g. NMF, these arguments should have an underscore in the name. This makes it a lot easier to read what the variable is.

I did not impose this on #224 because we also want internal consistency. This PR changes the neuropil module as well as core.Experiment.

@scottclowe scottclowe added the vX.Y.0 New Minor Release This should be included in a minor release label Jul 9, 2021
@scottclowe scottclowe requested a review from swkeemink July 9, 2021 19:41
@codecov
Copy link

codecov bot commented Jul 9, 2021

Codecov Report

Merging #230 (b47e5aa) into master (f8b3cd3) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #230   +/-   ##
=======================================
  Coverage   92.45%   92.45%           
=======================================
  Files           8        8           
  Lines         941      941           
  Branches      197      197           
=======================================
  Hits          870      870           
  Misses         34       34           
  Partials       37       37           
Flag Coverage Δ
nbsmoke 65.88% <50.00%> (ø)
unittests 92.02% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
fissa/core.py 94.52% <100.00%> (ø)
fissa/neuropil.py 91.66% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f8b3cd3...b47e5aa. Read the comment docs.

@scottclowe
Copy link
Member Author

Requires #231.

@scottclowe scottclowe merged commit b9f8b79 into rochefort-lab:master Jul 9, 2021
@scottclowe scottclowe deleted the api_rename-maxes branch July 9, 2021 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
vX.Y.0 New Minor Release This should be included in a minor release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant