Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SR-15585] Invalid task group list items do not have source locations #195

Closed
karwa opened this issue Dec 12, 2021 · 3 comments
Closed

[SR-15585] Invalid task group list items do not have source locations #195

karwa opened this issue Dec 12, 2021 · 3 comments
Labels
bug Something isn't working

Comments

@karwa
Copy link

karwa commented Dec 12, 2021

Previous ID SR-15585
Radar rdar://problem/89641499
Original Reporter @karwa
Type Bug
Environment

Swift-DocC 92f7fe1

Also present in the Xcode 13.1 build

macOS 11.6

Additional Detail from JIRA
Votes 0
Component/s Swift-DocC
Labels Bug
Assignee None
Priority Medium

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:

diagnostic.source = context.documentLocationMap[nodeReference]

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.

/// A thing
///
/// ## Topics
///
/// ### Things about Things
///
/// - bar
///
struct Foo {
}
@franklinsch
Copy link
Member

@swift-ci create

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 3, 2022
@groue
Copy link

groue commented Apr 6, 2023

Thanks for mentioning the warning text, so that I could perform a web search and find this issue 👍

The obscure warning is still there in Xcode 14.3 (14E222b).

@d-ronnqvist
Copy link
Contributor

d-ronnqvist commented Dec 21, 2023

I believe that this was fixed by #753

Feel free to reopen this issue if the issue still remains on new main builds of DocC.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

5 participants