swiftlang/swift-docc

Highlight deleted code

Open

#515 opened on Mar 13, 2023

View on GitHubContributor guide
 (9 comments) (0 reactions) (0 assignees)Swift (181 forks)auto 404
good first issuenew feature

Repository metrics

Stars
 (1,356 stars)
PR merge metrics
 (Avg merge 24d 11h) (33 merged PRs in 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

Contributor guide

Research direction
Explore the swift docc renderer source code to understand how it currently highlights code lines (e.g., added lines). Then implement similar logic for deleted lines, possibly using a red background color. Look at the example PR for reference.
Tech stack
swift
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Swift
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60