swiftlang/swift-docc

Highlight deleted code

Aberta

#515 aberto em 13 de mar. de 2023

Ver no GitHubGuia do colaborador
 (9 comentários) (0 reação) (0 responsável)Swift (181 forks)auto 404
good first issuenew feature

Métricas do repositório

Stars
 (1.356 estrelas)
Métricas de merge de PR
 (Mesclagem média 24d 11h) (33 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Explore o código fonte do renderizador do swift docc para entender como ele atualmente destaca linhas de código (por exemplo, linhas adicionadas). Em seguida, implemente lógica semelhante para linhas excluídas, possivelmente usando uma cor de fundo vermelha. Consulte o exemplo de PR.
Pilha de tecnologia
swift
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Swift
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60