ModellingWebLab / cellmlmanip

CellML loading and model equation manipulation
Other
3 stars 1 forks source link

Reorder methods & classes for readability #280

Closed jonc125 closed 4 years ago

jonc125 commented 4 years ago

Description

In both model.py and units.py I've tried to group related methods together, and put the most useful parts to users at the top.

@MichaelClerx I think it'd be easier to merge this before your open PRs and then apply them on top, rather than the other way around.

Motivation and Context

It's easier to navigate the source if related things are together. And this makes the docs read better as well since they follow the ordering in the source code.

Types of changes

There are no functionality changes at all, just reordering.

Checklist:

Testing

codecov[bot] commented 4 years ago

Codecov Report

Merging #280 into develop will not change coverage. The diff coverage is 99.11%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #280   +/-   ##
========================================
  Coverage    97.52%   97.52%           
========================================
  Files            7        7           
  Lines         1336     1336           
  Branches       287      287           
========================================
  Hits          1303     1303           
  Misses          15       15           
  Partials        18       18           
Impacted Files Coverage Δ
cellmlmanip/units.py 98.37% <96.42%> (ø)
cellmlmanip/model.py 99.77% <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 9c4814f...6020a42. Read the comment docs.