JuliaDynamics/Agents.jl

Agents.jl examples plot in the highlight section should be regenerated

Open

#1032 opened on May 8, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Julia (904 stars) (146 forks)batch import
documentationgood first issueplotting

Description

here https://juliadynamics.github.io/Agents.jl/stable/#Highlights the plotting of flocking is wrong because there was a bug in behaviour, I fixed it sometime ago, but we didn't regenerate this plot

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate the script that generates the flocking plot for the Highlights section of the documentation. The plot is generated from the example code in the repository. After the bug fix, run the plotting script to regenerate the image and update the documentation. The relevant files are likely in the docs/ or scripts/ directory of the Agents.jl repository.