JuliaDynamics/Agents.jl

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

Open

#965 geöffnet am 3. Feb. 2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Julia (146 Forks)batch import
good first issuequality of life

Repository-Metriken

Stars
 (904 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 12h 3m) (1 gemergte PR in 30 T)

Beschreibung

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...?

Contributor Guide

Research-Richtung
Untersuche das `@agent` Makro in Agents.jl (wahrscheinlich in src/agents.jl oder ähnlich), um zu verstehen, wie es derzeit Structs definiert. Sieh dir an, wie `Base.show` für andere Typen im Repository implementiert ist. Modifiziere das Makro, um automatisch eine benutzerdefinierte `show` Methode zu generieren, die jedes Feld mit seinem Namen, Typ und Wert in einer separaten Zeile ausgibt. Stelle die Kompatibilität mit bestehendem Code sicher. Der Maintainer hat keine zusätzlichen Anleitungen gegeben, daher sollte die Implementierung dem üblichen Julia Stil folgen.
Tech Stack
Keine
Domain
developer experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Julia macrosAgents.jl frameworkBase.show
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80