[SR-15408] Building documentation with a fallback display name that includes a space produces a broken-looking article

[apple]

[SR-15408] Building documentation with a fallback display name that includes a space produces a broken-looking article

[swift-ci]

Comment by Waheed Afolabi (JIRA)

Hi @ethan-kusters, I'd like to take this up if I can get some guidance!

[d-ronnqvist]

Hi waheedNowLovesSwift (JIRA User), if you still like to take this I can help you with that.

There's a type called GeneratedDataProvider that generates a documentation bundle when docc is passed a directory of symbol graph files without also being passed a documentation catalog as input.

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.

[d-ronnqvist]

Alternatively I can find some time to work on this later this week.

[d-ronnqvist]

I opened a PR here #52

[swift-ci]

Comment by Waheed Afolabi (JIRA)

@d-ronnqvist seems you've worked on this already!?

[d-ronnqvist]

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.

[swift-ci]

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!