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

Preformatted Markdown is split up (even when it doesn't contain spaces #825

Open
1 of 2 tasks
louwers opened this issue May 11, 2024 · 2 comments
Open
1 of 2 tasks
Labels
bug Something isn't working

Comments

@louwers
Copy link

louwers commented May 11, 2024

Description

When using preformatted text, such as

`UIViewRepresentable`

the Markdown parser that DocC uses can split it up:

image

Checklist

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

Do not split up preformatted text.

Actual behavior

Here is the code that is generated:

<p>To use MapLibre ... (using <code data-v-05f4a5b7="">UIView<wbr data-v-05f4a5b7="">Representable</code>. The...</p>

Steps To Reproduce

  1. Include pre-formatted text near the end of a line
  2. Watch it get split up!

Swift-DocC Version Information

No response

Swift Compiler Version Information

swift-driver version: 1.87.3 Apple Swift version 5.9.2 (swiftlang-5.9.2.2.56 clang-1500.1.0.2.5)
Target: arm64-apple-macosx14.0
@louwers louwers added the bug Something isn't working label May 11, 2024
@d-ronnqvist d-ronnqvist transferred this issue from swiftlang/swift-docc May 13, 2024
@d-ronnqvist
Copy link
Contributor

DocC itself generates a single inline code element for this. I suspect that it's DocC-Render who divides the word on capitalized letters to allow it to span multiple lines.

@louwers
Copy link
Author

louwers commented May 13, 2024

I see! Thanks for transferring it.

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

2 participants