JuliaDynamics/Agents.jl

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

Open

#965 ouverte le 3 févr. 2024

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Julia (146 forks)batch import
good first issuequality of life

Métriques du dépôt

Stars
 (904 stars)
Métriques de merge PR
 (Merge moyen 12h 3m) (1 PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Étudiez la macro `@agent` dans Agents.jl (probablement dans src/agents.jl ou similaire) pour comprendre comment elle définit actuellement les structs. Examinez comment `Base.show` est implémenté pour d'autres types dans le dépôt. Modifiez la macro pour générer automatiquement une méthode `show` personnalisée qui affiche chaque champ avec son nom, son type et sa valeur sur une ligne séparée. Assurez la compatibilité avec le code existant. Le mainteneur n'a pas fourni de conseils supplémentaires, donc l'implémentation doit suivre le style courant de Julia.
Stack technique
Aucun
Domaine
developer experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Julia macrosAgents.jl frameworkBase.show
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80