You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If there is a non-link item in a "See Also" list or Topics list in a Swift source file, DocC will emit a warning: "Only links are allowed in task group list items" without a source location.
This makes locating the cause of the warning incredibly difficult. The only way I was able to discover where these things were coming from is by building my own version of DocC with a bunch of "dump()" calls thrown around.
Add an item to a "See Also" list or "Topics" list which is just plain text (not a link), and build documentation. DocC will emit a warning with no location.
/// A thing////// ## Topics////// ### Things about Things////// - bar///structFoo {
}
The text was updated successfully, but these errors were encountered:
Environment
Swift-DocC 92f7fe1
Also present in the Xcode 13.1 build
macOS 11.6
Additional Detail from JIRA
md5: 9c2a4789ba12c4f99e093155320236fb
Issue Description:
If there is a non-link item in a "See Also" list or Topics list in a Swift source file, DocC will emit a warning: "Only links are allowed in task group list items" without a source location.
This makes locating the cause of the warning incredibly difficult. The only way I was able to discover where these things were coming from is by building my own version of DocC with a bunch of "dump()" calls thrown around.
This revealed that DocumentCurator was unable to find a document location for the node reference here: https://github.com/apple/swift-docc/blob/d94139a5e64e9ecf158214b1cded2a2880fc1b02/Sources/SwiftDocC/Infrastructure/DocumentationCurator.swift#L176
Steps to reproduce:
Add an item to a "See Also" list or "Topics" list which is just plain text (not a link), and build documentation. DocC will emit a warning with no location.
The text was updated successfully, but these errors were encountered: