issue #22 : fix examples #27
Conversation
README.md
Outdated
| @@ -34,20 +45,19 @@ The package is available in pypi with a linux environment for python 3.6, 3.7, 3 | |||
| ############################### | |||
| # The file is available here : https://github.com/moead-framework/data/blob/master/problem/RMNK/Instances/rmnk_0_2_100_1_0.dat | |||
| # Others instances are available here : https://github.com/moead-framework/data/tree/master/problem/RMNK/Instances | |||
| instance_file = "rmnk_0_2_100_1_0.dat" | |||
| instance_file = "moead_framework/test/data/instances/rmnk_0_2_100_1_0.dat" | |||
There was a problem hiding this comment.
I would revert the full path to just the filename, I don't think you can guarantee that people will create their example file from this README in your repo directory, since you also offer it to be pip installable.
There was a problem hiding this comment.
@chkoar I agree that these issues still have to be sufficiently addressed, and the result of that should also be applied to update these examples. But I think that is separate from the main issue I'm pointing out in this line, which is that an example file should not explicitly include a relative path like this, as there is no guarantee that path can be successfully resolved wherever the user may decide to run their example. Especially when this package is pip installed, this relative path will always fail
|
the full path of files is reverted and I fixed the code formatting in 22534e9 of this PR |
fix readme.md and example in the documentation