Skip to content

Some updates to the documentation #1188

@damianodegaspari

Description

@damianodegaspari

The documentation needs two small updates

One.
In Step 2: redefining agent types](https://juliadynamics.github.io/Agents.jl/dev/tutorial/#Step-2:-redefining-agent-types) of the tutorial there is a note, explaining how structs in julia can not be redefined without restarting the session. If I am not mistaken, this is not a problem anymore with julia 1.12.

Two.
In the Plotting and interactivity page of the documentation, there is the following description of one of the keyword arguments of the ambplot function:

static_preplot! : A function f(ax, abmplot) that plots something after the heatmap but before the agents.

From this, I personally don't understand exactly how it should be used. But maybe this is not relevant anymore, as trying it out I got the following warning:

┌ Warning: Usage of the static_preplot! kwarg is deprecated. Please remove it from the call to abmplot and define a custom method for Agents.static_preplot!(ax, model, p) instead.
└ @ AgentsVisualizations ~/.julia/packages/Agents/WuWeG/ext/AgentsVisualizations/src/spaces/abstract.jl:38

Shouldn't it then be removed? If yes, maybe also its other occurrences in the documentation would need to be updated. Searching for 'static_preplot!' gives me 5 results.

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