Skip to content

removes logic duplicated in SymbolKit#1091

Closed
heckj wants to merge 2 commits into
swiftlang:mainfrom
heckj:duplicate-logic
Closed

removes logic duplicated in SymbolKit#1091
heckj wants to merge 2 commits into
swiftlang:mainfrom
heckj:duplicate-logic

Conversation

@heckj

@heckj heckj commented Nov 7, 2024

Copy link
Copy Markdown
Member

While debugging #1084, I found this duplicate logic (and the source of the issue). There's an open pull request to resolve the error in SymbolKit (swiftlang/swift-docc-symbolkit#89), and this compliments that pull request to resolve #1084, using the logic in SymbolKit over duplicate, local logic.

I opted for SymbolKit's implementation in this case because its method is public, while the local method was private.

  • prefer SymbolKit for this logic

@heckj heckj force-pushed the duplicate-logic branch 2 times, most recently from 92fc12e to 74059be Compare November 15, 2024 17:56
@Kyle-Ye

Kyle-Ye commented Nov 16, 2024

Copy link
Copy Markdown
Contributor

@swift-ci please test

@Kyle-Ye Kyle-Ye left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Waiting for the symbolkit PR and other's suggestion before a merge.

@heckj

heckj commented Dec 2, 2024

Copy link
Copy Markdown
Member Author

(rebased, but otherwise no changes in that last commit)

@Kyle-Ye

Kyle-Ye commented Dec 3, 2024

Copy link
Copy Markdown
Contributor

@swift-ci test

let isMainSymbolGraph = !url.lastPathComponent.contains("@")

let moduleName: String
if isMainSymbolGraph || symbolGraph.module.bystanders != nil {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I see that this version has a symbolGraph.module.bystanders != nil check, but the SymbolKit version doesn't. Do we need it? cc @QuietMisdreavus

@franklinsch franklinsch self-requested a review February 3, 2025 17:05
 - prefer SymbolKit for this logic
@heckj

heckj commented Feb 28, 2025

Copy link
Copy Markdown
Member Author

@swift-ci test

@heckj heckj mentioned this pull request Aug 28, 2025
3 tasks
@heckj

heckj commented Aug 28, 2025

Copy link
Copy Markdown
Member Author

closing in favor of #1286

@heckj heckj closed this Aug 28, 2025
@heckj heckj deleted the duplicate-logic branch August 28, 2025 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

race condition with docc preview that appears to be acerbated by including snippets in DocC content

3 participants