Move `add/remove_agent_from_space!` to the public API · JuliaDynamics/Agents.jl#1154

(3 评论) (0 反应) (0 负责人)Julia (904 star) (146 fork)batch import

good first issuespace interaction api

描述

Following from the discussion here: https://discourse.julialang.org/t/remove-agent-from-space-but-not-scheduler/127842/10

The summary is: there are good reasons for users to be able to directly add or remove agents to a space, without removing them from existence (the ABM itself) alltogether.

To do this we need to make the add/remove_agent_from_space! public, and also:

In its docstring document that this function is already called internally in add_agent! or remove_agent! and therefore does nto have to be manually called by the user if they are doing this operation.
Test EXTENSIVELY in ALL SPACES whether using these functions directly without add/remove_agent! leads to any breakages.

This feature is a pre-requisitive step for #910 .

贡献者指南

技术栈: 无
领域: api
议题类型: feature
难度: 4
预计时间: 3-5 days
活动状态: fresh
清晰度: clear
前置要求: Agents.jl library usageJulia language fundamentalsUnderstanding of space types
新手友好度: 45
研究方向: The task involves making `add agent from space!` and `remove agent from space!` public by exporting them and adding documentation. The docstring should clarify that these are called internally. Testing should be performed across all space implementations, likely in `test/` directory. Refer to issue #910 for the follow up feature. The discourse discussion provides context for the design decision.