funkelab / motile

Multi-Object Tracker using Integer Linear Equations
https://funkelab.github.io/motile/
MIT License
27 stars 5 forks source link

Many updates to documentation, add docstyle linting #46

Closed tlambert03 closed 1 year ago

tlambert03 commented 1 year ago

This PR makes a lot of updates to the documentation,

example parameters section before this PR:

Screen Shot 2023-05-17 at 5 04 31 PM

example after this PR:

Screen Shot 2023-05-17 at 5 03 35 PM
codecov-commenter commented 1 year ago

Codecov Report

Merging #46 (108c79e) into main (8830ca6) will decrease coverage by 0.22%. The diff coverage is 81.81%.

@@            Coverage Diff             @@
##             main      #46      +/-   ##
==========================================
- Coverage   92.86%   92.65%   -0.22%     
==========================================
  Files          32       32              
  Lines         757      762       +5     
==========================================
+ Hits          703      706       +3     
- Misses         54       56       +2     
Files Coverage Δ
motile/constraints/constraint.py 100.00% <ø> (ø)
motile/constraints/expression.py 92.50% <ø> (ø)
motile/constraints/max_children.py 100.00% <ø> (ø)
motile/constraints/max_parents.py 100.00% <ø> (ø)
motile/constraints/pin.py 100.00% <ø> (ø)
motile/constraints/select_edge_nodes.py 100.00% <ø> (ø)
motile/costs/appear.py 100.00% <ø> (ø)
motile/costs/costs.py 85.71% <ø> (ø)
motile/costs/disappear.py 100.00% <ø> (ø)
motile/costs/edge_distance.py 47.05% <ø> (ø)
... and 17 more