Skip to content

Commit

Permalink
Update docstring of SimEvent (#2417)
Browse files Browse the repository at this point in the history
* Update eventlist.py

* ruff related fix
  • Loading branch information
quaquel authored Oct 25, 2024
1 parent e40075d commit 3225dbb
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions mesa/experimental/devs/eventlist.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ class SimulationEvent:
function_args (list[Any]): Argument for the function
function_kwargs (Dict[str, Any]): Keyword arguments for the function
Notes:
simulation events use a weak reference to the callable. Therefore, you cannot pass a lambda function in fn.
A simulation event where the callable no longer exists (e.g., because the agent has been removed from the model)
will fail silently.
"""

_ids = itertools.count()
Expand Down

0 comments on commit 3225dbb

Please sign in to comment.