Skip to content

API Documentation shows HTML entities and missing spaces #2991

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

Closed
lfielke opened this issue Oct 18, 2021 · 2 comments
Closed

API Documentation shows HTML entities and missing spaces #2991

lfielke opened this issue Oct 18, 2021 · 2 comments
Labels
docs KDoc and API reference

Comments

@lfielke
Copy link

lfielke commented Oct 18, 2021

Reading the "Full kotlinx.coroutines API reference" linked in the project README, I've noticed that some pages show HTML entities in the documentation text instead of the desired character, as well as missing some spaces between words.

For example, on this page about the shareIn extension method, "coldFlow" and "hotSharedFlow" should have spaces after 'cold' and 'hot', respectively, in the first sentence; and the bullet points should have em-dashes rather than showing the raw HTML entity —.
https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/share-in.html

Screenshot showing how Chromium on Linux renders the page, with red annotations showing the above problems:
image

I note that IntelliJ seems to render the documentation string for shareIn as intended, neither of the above problems are present in the quick documentation popup for shareIn.

@qwwdfsad
Copy link
Collaborator

Filed Kotlin/dokka#2200, will be fixed with Dokka update when the issue is fixed there

qwwdfsad added a commit that referenced this issue Apr 26, 2022
qwwdfsad added a commit that referenced this issue Apr 26, 2022
@lfielke
Copy link
Author

lfielke commented May 4, 2022

Thanks for the update, I can see the HTML entities are fixed, but the missing spaces remain for me on that page. Screenshot in FireFox on Mac:

image

I think that "coldFlow" and "hotSharedFlow" near the red scribbles should be "cold Flow" and "hot SharedFlow" (with spaces separating the words).

pablobaxter pushed a commit to pablobaxter/kotlinx.coroutines that referenced this issue Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs KDoc and API reference
Projects
None yet
Development

No branches or pull requests

3 participants