swiftlang/swift-docc

Highlight deleted code

Offen

#515 geöffnet am 13.03.2023

Auf GitHub ansehenContributor Guide
 (9 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Swift (181 Forks)auto 404
good first issuenew feature

Repository-Metriken

Stars
 (1.356 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 24T 11h) (33 gemergte PRs in 30 T)

Beschreibung

Feature Name

Highlight deleted code

Description

Highlight deleted lines (potentially using red background colour).

Motivation

Sometimes (especially when starting out from a template), you need to tell the reader to delete one of more lines of code. It seems like the renderer is not capable of highlighting deleted lines.

Here is an example;

https://github.com/peterfriese/MakeItSo/pull/94#discussion_r1134366287

Importance

No response

Alternatives Considered

No response

Contributor Guide

Research-Richtung
Erkunde den Quellcode des swift docc Renderers, um zu verstehen, wie er derzeit Codezeilen hervorhebt (z.B. hinzugefügte Zeilen). Implementiere dann eine ähnliche Logik für gelöschte Zeilen, möglicherweise mit einem roten Hintergrund. Siehe das Beispiel PR als Referenz.
Tech Stack
swift
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Swift
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60