Open szhorvat opened 8 months ago
First of all, I must say that it is very nice that the documentation of several functions comes with examples.
However, one of the first examples I tried did not complete after more than a 5 minute runtime (M2 MacBook Pro):
https://hypernetx.readthedocs.io/en/latest/algorithms/algorithms.html#algorithms.contagion.contagion_animation
When an example takes a very long time to run, this should be noted in the docs.
Ref: https://github.com/openjournals/joss-reviews/issues/6016
First of all, I must say that it is very nice that the documentation of several functions comes with examples.
However, one of the first examples I tried did not complete after more than a 5 minute runtime (M2 MacBook Pro):
https://hypernetx.readthedocs.io/en/latest/algorithms/algorithms.html#algorithms.contagion.contagion_animation
When an example takes a very long time to run, this should be noted in the docs.
Ref: https://github.com/openjournals/joss-reviews/issues/6016