Skip to content

Incorrect error reporting on older topic-style symbol reference that isn't used in code or documentation markdown #640

@heckj

Description

@heckj

Description

WIth the Swift 5.9 updates to DocC that change the symbols to allow full unicode character support, I've updated my documentation - but am continuing to get warnings about incorrect symbols. I'm opening this issue per a discussion on the swift forums.

The example that shows this is MeshGenerator, and a perfect example is the symbol TextureCoordinates/_=(_:_:)-38jci.

The kind of warning that is displayed (in both Xcode and from DocC on the command line) is:

/Users/heckj/src/MeshGenerator/Sources/MeshGenerator/MeshGenerator.docc/Extensions/TextureCoordinates.md: warning: '_=(_:_:)-38jci' doesn't exist at '/MeshGenerator/TextureCoordinates'

This package exhibits several of these warnings, all apparently related to synthesized methods from default protocol conformance.

I've also verified this behavior exists on the current main branch of DocC (commit 2131c4358d9345cb72007dd53cca33ef410cf6b6).

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

No warnings displayed

Actual behavior

Warnings displayed, such as:

/Users/heckj/src/MeshGenerator/Sources/MeshGenerator/MeshGenerator.docc/Extensions/TextureCoordinates.md: warning: '_=(_:_:)-38jci' doesn't exist at '/MeshGenerator/TextureCoordinates'

When I've not added the symbol to any markdown (or more explicitly, I've replaced it)

Steps To Reproduce

Project: MeshGenerator

  • git clone https://github.com/heckj/MeshGenerator
  • cd MeshGenerator
  • git checkout 9912f61d3222a76364b156c6055be35fd48c348c

verify that the symbol isn't in use in code or markdown files:

  • grep -R "\_=(_:_:)-38jci" .

exhibit the errors

  • ./docbuild.bash

or the more explicit version:

  • $(xcrun --find swift) package generate-documentation --target MeshGenerator

Swift-DocC Version Information

5.9.0

Swift Compiler Version Information

swift-driver version: 1.82.2 Apple Swift version 5.9 (swiftlang-5.9.0.114.10 clang-1500.0.29.1)
Target: arm64-apple-macosx13.0

Metadata

Metadata

Assignees

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