AlgebraicJulia/Catlab.jl

Allow specification of MIME type of labels in wiring diagrams

Offen

#565 geöffnet am 10.11.2021

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (68 Forks)batch import
enhancementgood first issuegraphicswiring diagrams

Repository-Metriken

Stars
 (706 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 17T 19h) (2 gemergte PRs in 30 T)

Beschreibung

Catlab escapes the HTML sequences in strings before substituting into the Graphviz "HTML-like" label. However, in order to have a Box whose label contains line breaks render properly, users should be able to specify a MIME type so that they can better control escaping.

Contributor Guide

Research-Richtung
Das Problem schlägt vor, Benutzern zu erlauben, einen MIME Typ für Beschriftungen in Verdrahtungsdiagrammen anzugeben, um die HTML Escapesequenz zu steuern. Zur Implementierung sollte man herausfinden, wie Catlab.jl Zeichenketten vor der Graphviz Substitution escaped, wahrscheinlich in Dateien wie `src/wiring diagrams.jl` oder ähnlichen. Ein neuer Parameter könnte zur Beschriftungsfunktion oder zum Box Konstruktor hinzugefügt werden, um einen MIME Typ zu akzeptieren, und die Escapelogik kann basierend auf diesem MIME Typ umgangen oder angepasst werden. Es wäre hilfreich, bestehende Tests für die Beschriftungsfunktionalität zu überprüfen und das Hinzufügen neuer Tests in Betracht zu ziehen.
Tech Stack
Keine
Domain
backend
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.
Meist klar
Voraussetzungen
Julia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60