swiftlang/swift-docc

Highlight deleted code

Ouverte

#515 ouverte le 13 mars 2023

Voir sur GitHubGuide contributeur
 (9 commentaires) (0 réaction) (0 personne assignée)Swift (181 forks)auto 404
good first issuenew feature

Métriques du dépôt

Stars
 (1 356 étoiles)
Métriques de merge PR
 (Merge moyen 24j 11h) (33 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Explorez le code source du rendu swift docc pour comprendre comment il met en surbrillance les lignes de code (par exemple, les lignes ajoutées). Ensuite, implémentez une logique similaire pour les lignes supprimées, en utilisant éventuellement un fond rouge. Référez vous à l'exemple de PR.
Stack technique
swift
Domaine
documentation
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.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Swift
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60