Skip to content

Symbol Disambiguation between Article and Anchor fails #1413

@fpseverino

Description

@fpseverino

Description

If an article title conflicts with an anchor name, adding DocC’s suggested disambiguation doesn't resolve it.

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

DocC should correctly resolve <doc:Transactions-article> to the Transactions.md article, or otherwise provide and suggest a valid and working disambiguation mechanism.

Actual behavior

DocC reports ambiguity, suggests -article, but then fails to resolve the suggested reference.

Steps To Reproduce

When compiling the following DocC catalog main page

### Transactions

- <doc:Transactions>
- ``STOMPTransaction``

with a Transactions.md file in the same folder, the following warning is generated:

warning: 'Transactions' is ambiguous at '/STOMPNIO'
  --> STOMPNIO.md:32:8-32:20
30 | ### Transactions
31 |
32 + - <doc:Transactions>
   |                    ├─suggestion: Insert '-anchor' for 'Transactions'
   |                    ╰─suggestion: Insert '-article' for 'Transactions'
33 | - ``STOMPTransaction``

After changing the main page to

### Transactions

- <doc:Transactions-article>
- ``STOMPTransaction``

the disambiguation doesn't get resolved and the following warning is thrown:

warning: 'Transactions-article' doesn't exist at '/STOMPNIO'
  --> STOMPNIO.md:32:8-32:28
30 | ### Transactions
31 |
32 + - <doc:Transactions-article>
   |        ╰─suggestion: Replace 'Transactions-article' with 'Transactions'
33 | - ``STOMPTransaction``

Swift-DocC Version Information

No response

Swift Compiler Version Information

swift-driver version: 1.127.14.1 Apple Swift version 6.2.3 (swiftlang-6.2.3.3.21 clang-1700.6.3.2)
Target: arm64-apple-macosx26.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions