Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Character substitution in file names can lead to collisions #285

Open
@Lukas-Stuehrk

Description

@Lukas-Stuehrk

When generating file names for symbols, swift-doc replaces some characters of the symbol's name with underscore (_).

This can lead to the problem that it produces the same file name for different symbols with different names. The second symbol then overwrites the page of the previously declared symbol.

This happens rather often with operators:

infix operator >>>
public func >>> (lhs: String, rhs: String) { }

infix operator <<<
public func <<< (lhs: String, rhs: String) { }

Both create the file ___.

But it can also happen for any other symbol:

public class Outer {
    public struct Inner {}
}

public class Outer_Inner {}

Both symbols create the file Outer_Inner.

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