JuliaDynamics/Agents.jl

[FR] make the `@agent` macro define pretty printing as well

Open

#965 aperta il 3 feb 2024

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Julia (146 fork)batch import
good first issuequality of life

Metriche repository

Star
 (904 star)
Metriche merge PR
 (Merge medio 12h 3m) (1 PR mergiata in 30 g)

Descrizione

Currently we have:

@agent struct SchellingAgent(GridAgent{2})
    mood::Bool # whether the agent is happy in its position
    group::Int # The group of the agent, determines mood as it interacts with neighbors
end

a = SchellingAgent(1, (1,1), true, 1)

which prints

SchellingAgent(1, (1, 1), true, 1)

wouldn't it be nice to have pretty printing by default, so that each field is printed in 1 line, along with its name, its type, and then = value ? I am sure this shouldn't be too difficult to do...?

Guida contributor

Direzione di ricerca
Indaga la macro `@agent` in Agents.jl (probabilmente in src/agents.jl o simile) per capire come definisce attualmente le struct. Esamina come `Base.show` è implementato per altri tipi nel repository. Modifica la macro per generare automaticamente un metodo `show` personalizzato che stampi ogni campo con il suo nome, tipo e valore su una riga separata. Assicura la compatibilità con il codice esistente. Il manutentore non ha fornito ulteriori indicazioni, quindi l'implementazione dovrebbe seguire lo stile comune di Julia.
Tech stack
Nessuno
Dominio
developer experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Julia macrosAgents.jl frameworkBase.show
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80