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.

Sign up for GitHub

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

Jump to bottom

[joss] Documentation example does not complete after > 5 min runtime #140

Open
szhorvat opened this issue Jan 17, 2024 · 0 comments
Open

[joss] Documentation example does not complete after > 5 min runtime #140

szhorvat opened this issue Jan 17, 2024 · 0 comments
Labels
backlog joss

Comments

@szhorvat
Copy link
Contributor

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: openjournals/joss-reviews#6016
@bonicim bonicim self-assigned this Jan 17, 2024
@bonicim bonicim added active Work in progress backlog and removed active Work in progress labels Jan 17, 2024
@bonicim bonicim removed their assignment Jan 22, 2024
@bonicim bonicim added the joss label Jan 22, 2024
bonicim added a commit that referenced this issue Feb 28, 2024
@bonicim
Pull request #140: Fix tests
6910e69 
Merge in HYP/hypernetx from fix-tests to develop

* commit '1556756e368052c8e72e89fbf584dc4113ddfa05':
  Fix tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backlog joss
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@szhorvat @bonicim