Fix DocC warnings #968
Fix DocC warnings #968
Conversation
| the device to focus on specific content in the scene. To learn more about using the ``FlyoverSceneView`` see the <doc:FlyoverSceneViewTutorial>. | ||
| the device to focus on specific content in the scene. To learn more see the <doc:FlyoverSceneViewTutorial>. |
There was a problem hiding this comment.
I'm not sure that we should make this change because these symbol links are helpful on other platforms. We host the iOS docC archive, not the mac catalyst docC archive so these warnings aren't really valid for our use case. I remember reading through this AR doc and I found these links helpful. Thoughts?
There was a problem hiding this comment.
I had suggested to @des12437 that she remove them because component name is already provided via the paragraph headers.
Also it looks like these links aren't live on the current published web version so I'm not sure what the targeted platform is when the docs are built for hosting:
Hopefully DocC supports compiler directives of some sort eventually.
@mhdostal thoughts?
There was a problem hiding this comment.
I had suggested to @des12437 that she remove them because the component name is already provided via the paragraph headers.
I remember when I was reading this that I would read each paragraph then I would want to look at the API and there was no convenient way to get there other than search the type. Not a huge deal I just think the symbol links are a nice addition.
Also it looks like these links aren't live on the current published web version so I'm not sure what the targeted platform is when the docs are built for hosting:
Weird. I knew the SDK was iOS but I just assumed the same here, I can double-check this because now I am curious.
There was a problem hiding this comment.
I can double-check this because now I am curious.
Yeah looks like it is using the iOS DocC archive, hmm weird.
There was a problem hiding this comment.
Oh, I know why. The symbol links were added in 200.6 and the doc you are looking at is for 200.5.
There was a problem hiding this comment.
just wish there was a way to eliminate all possible warnings.
I agree with that 😮💨
There was a problem hiding this comment.
I can revert these changes for now.
There was a problem hiding this comment.
Hopefully DocC supports compiler directives of some sort eventually.
Maybe we can log an issue like swiftlang/swift-docc#255 but specify our need to allow skipping certain symbols for visionOS.
There was a problem hiding this comment.
Maybe we can log an issue like swiftlang/swift-docc#255 but specify our need to allow skipping certain symbols for visionOS.
Good idea @yo1995. I can log an issue.
There was a problem hiding this comment.
Resolves DocC warnings on Mac Catalyst caused by unrecognized symbol links.