Skip to content

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

Open

Description

@szhorvat

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

Activity

  1. self-assigned this
    on Jan 17, 2024
  2. added
    activeWork in progress
    and removed
    activeWork in progress
    on Jan 17, 2024
  3. removed their assignment
    on Jan 22, 2024
  4. added a commit that references this issue on Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions