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-15754] Override merge behaviour removes all Xcode popover documentation #189

Closed
karwa opened this issue Jan 19, 2022 · 1 comment
Closed
Labels
bug Something isn't working

Comments

@karwa
Copy link

karwa commented Jan 19, 2022

Previous ID SR-15754
Radar None
Original Reporter @karwa
Type Bug

Attachment: Download

Environment

macOS 11.6, Xcode 13.2.1 (13C100)

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

md5: ee66e5044a4c31ce0a974d83ef42f904

Issue Description:

In my package, I have a type which is documented via a markdown extension doc. This looks great in the documentation browser, but I also want to provide great documentation in the Xcode alt+click popover.

Currently, the default appears to append the source docs with the extension docs, meaning I need to limit the popover docs to just the first line:

Code:

Popover:

Documentation browser (notice the summary up top comes from the source docs):


Now, if I extend the source docs with a longer (yet still abbreviated) summary, I get a better popover experience, but the documentation browser duplicates it, with 2 overview sections:

Popover:

Documentation browser:


Now, if I add specify the "override" merge behaviour in the markdown document, I can remove the duplicated content in the documentation browser, but now get absolutely no popover documentation at all, despite there obviously being documentation which you can see in the background.

This means I'm not able to provide a great popover and documentation browser experience simultaneously 🙁

@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
@d-ronnqvist
Copy link
Contributor

AFAICT this isn't an issue in Xcode 15.

Regardless, issues about Xcode specific features are out of scope for this repo. For that, please file a Feedback instead.

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

3 participants