swiftlang/swift-docc

Highlight deleted code

Aperta

#515 aperta il 13 mar 2023

Vedi su GitHubGuida contributor
 (9 commenti) (0 reazioni) (0 assegnatari)Swift (181 fork)auto 404
good first issuenew feature

Metriche repository

Star
 (1356 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esplora il codice sorgente del renderer di swift docc per capire come attualmente evidenzia le righe di codice (ad esempio, le righe aggiunte). Quindi implementa una logica simile per le righe eliminate, possibilmente usando uno sfondo rosso. Fai riferimento all'esempio PR.
Tech stack
swift
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Swift
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60