swiftlang/swift-docc

Impossible to put same link in body and see also with different title

Open

#480 opened on Feb 15, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Swift (181 forks)auto 404
bugenhancementgood first issue

Repository metrics

Stars
 (1,356 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

Markdown

For more information see the [specification](https://example.com).

## See Also
- [Full Name of the Specification](https://example.com)

Checklist

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

Expected Result

For more information see the specification.

See Also

Actual behavior

Actual Result

For more information see the specification.

See Also

Steps To Reproduce

  1. Put following documentation:
For more information see the [specification](https://example.com).

## See Also
- [Full Name of the Specification](https://example.com)

Swift-DocC Version Information

Latest Xcode and also master

Swift Compiler Version Information

swift-driver version: 1.62.15 Apple Swift version 5.7.2 (swiftlang-5.7.2.135.5 clang-1400.0.29.51)
Target: arm64-apple-macosx13.0

Contributor guide

Research direction
Investigate how Swift DocC resolves link titles in 'See Also' sections. Look at the rendering logic where the same URL with different titles in body and see also leads to the body's title overriding the see also title.
Tech stack
swift
Domain
documentationdeveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
SwiftGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65