accept sameShape constraint kind from SymbolKit #1290
Conversation
|
@swift-ci Please test |
| } | ||
|
|
||
| func testRenderSameShape() async throws { | ||
| let (_, bundle, context) = try await testBundleAndContext(copying: "LegacyBundle_DoNotUseInNewTests", excludingPaths: []) { bundleURL in |
There was a problem hiding this comment.
Don't use this test fixture in new tests.
|
It looks like DocC doesn't use constraint information directly from a symbol (instead only sourcing it from extensions), and Swift places |
QuietMisdreavus
force-pushed
the
same-shape
branch
from
cb1d63e to
6d81acb
Compare
|
@swift-ci Please test |
Is there some place where it would make sense to display this information on the page? That would both help us verify that DocC handles this type of constraint and would communicate that information to the reader. |
| case .conformance: return "conforms to" | ||
| case .sameType: return "is" | ||
| case .superclass: return "inherits" | ||
| case .sameShape: return "is the same shape as" |
There was a problem hiding this comment.
Considering that we this user-facing text. Should this PR also display that somewhere?
| )! | ||
|
|
||
| let catalog = Folder(name: "unit-test.docc", content: [ | ||
| InfoPlist(displayName: "SameShapeConstraint", identifier: "com.test.example"), |
There was a problem hiding this comment.
FYI: this isn't needed
| InfoPlist(displayName: "SameShapeConstraint", identifier: "com.test.example"), |
It would probably make sense to insert conditionals like this as part of the declarations section or something like that. I don't think Swift-DocC-Render is equipped to display conformance information there, though, so an update to display this data would also require an update there. |
Bug/issue #, if applicable: rdar://129338238, swiftlang/swift-docc-symbolkit#97
Summary
This PR updates Swift-DocC to render constraint information for
sameShapeconstraints, as received from SymbolKit.sameShapeconstraints are used in functions with parameter packs, to ensure that the packs have the same length and/or type data.Dependencies
swiftlang/swift-docc-symbolkit#103
Testing
Generate a symbol graph for a function that uses multiple parameter packs, such as this one from the above-linked issue:
Steps:
swift run docc convert /path/to/test.doccChecklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded