search

funkelab / motile

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

Wrong method names in API documentation and example notebook #116

Open snownontrace opened 3 months ago

snownontrace commented 3 months ago

In both the API documentation and the example notebook: "add_cost" and "add_constraint" should be "add_costs" and "add_constraints."

snownontrace commented 3 months ago

It turns out the API documentation is incomplete/outdated. For example, there is no documentation on the motile.plot module.

cmalinmayor commented 3 months ago

The API documentation is up-to-date with the main branch, but ahead of the latest PyPI release. The changed function names (#63 - issue and #108 - closed PR) and moving plotting functionality to the motile_toolbox library (#105 - issue and #110 - open PR) are recent changes in preparation for releasing a more stable Version 1.

That said, we do manually select the classes to document in the API, which is definitely subject to getting outdated. Are there also missing Cost and Constraint classes? Or just the plotting, which we are going to move.

We can also reconsider if the docs should be deployed only on release, to avoid confusion for users who install from PyPI.

snownontrace commented 3 months ago

Thanks, Caroline. Yes, it will be helpful to have the documentation matching the release.

Costs and Constraints are there. I only noticed plotting was missing at the moment.