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

Wrong method names in API documentation and example notebook #116

Open
snownontrace opened this issue Aug 9, 2024 · 3 comments
Open

Wrong method names in API documentation and example notebook #116

snownontrace opened this issue Aug 9, 2024 · 3 comments

Comments

@snownontrace
Copy link

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

@snownontrace
Copy link
Author

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

@cmalinmayor
Copy link
Contributor

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

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.

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

No branches or pull requests

2 participants