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-15408] Building documentation with a fallback display name that includes a space produces a broken-looking article #211
Comments
Comment by Waheed Afolabi (JIRA) Hi @ethan-kusters, I'd like to take this up if I can get some guidance! |
Hi waheedNowLovesSwift (JIRA User), if you still like to take this I can help you with that. There's a type called This generated bundle is defined to contain a single markup file and the in-memory content for that file is generated here. There's an assumption here that the display name provided via `--fallback-display-name` matches the module name of one of the symbol graphs. It would be more correct to instead generate in-memory markup files from the module names in the symbol graph files. |
Alternatively I can find some time to work on this later this week. |
I opened a PR here #52 |
Comment by Waheed Afolabi (JIRA) @d-ronnqvist seems you've worked on this already!? |
Yes. If you want to work on something else in this area Ethan opened https://bugs.swift.org/browse/SR-15572 as a follow up change to this. I can talk give you some guidance on where in the code to work on that. Just a heads up about that, depending on the design, that change should likely have a brief pitch in the forums since it potentially adds new developer facing syntax. If you want to work on the implementation but not make the pitch I can make the pitch in the forums and leave the implementation to you (and provide guidance). I can also provide guidance on another bug if there's something else that you want to work on. Just assign the bug to yourself and @mention me in the comments. |
Comment by Waheed Afolabi (JIRA) Okay @d-ronnqvist I'll be glad to work on this, https://bugs.swift.org/browse/SR-15572. Your guidance will be of immense importance for me as this would be my first contribution! |
Attachment: Download
Environment
Reproduced with commit hash
ba393152de75579fe4c60a8d7da2b3a719c31998
on themain
branch.Additional Detail from JIRA
md5: bd37b05faf06107586133ec6b88d0a65
Issue Description:
If I pass a fallback display name with a space (like
--fallback-display-name "My Display Name"
) todocc
, along with a valid symbol graph, DocC generates an article with``My Display Name``
as the H1 heading and organizes it under an “Articles” topic group on my top-level framework page. I don’t expect this article to be created at all.Reproduction Steps:
Download the attached symbol graph
Run the following:
The text was updated successfully, but these errors were encountered: