-
-
Notifications
You must be signed in to change notification settings - Fork 73
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
Example links in documentation of latest release point to current master implementation #145
Comments
Actually the example on the master branch is the newer one, but if you're using 0.4.7 then you will need the "older one". Thanks for reporting this though, because the documentation on docs.rs is wrongly linking to the example on the master branch, which is not helpful at all. I will fix this hopefully soon. |
I'm not sure, what you mean. Isn't 0.4.7 the newest version? Or is the one on the master branch already the example for 0.4.8 or 0.5.0? Anyway, thank you for working on fixing the issue! :) |
The master branch is currently ahead of 0.4.7 (which is the newest released version). In the master branch you will also find changes which aren't released yet. In this case for instance #139, which allows one to choose the random number generator used in SA. |
I tried to fix this, but none of the options I could come up with was satisfactory:
I would prefer it if it was possible to add the examples to the documentation directly. Since this is not possible right now I'm not sure how to properly address this right now. I might just remove the individual links in the documentation and have two dedicated links to the examples on the main page of the documentation. |
It's unfortunate that there's no optimal solution atm. Thank you for doing your best though! |
This example on the master branch seems a little outdated. Only by reading through other issues in this repo I was able to find this new example.
I'd like to suggest that at least the new example should get referenced in the newest documentation. https://docs.rs/argmin/0.4.7/argmin/solver/simulatedannealing/struct.SimulatedAnnealing.html Currently, it links to the old, outdated one.
The text was updated successfully, but these errors were encountered: