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.

Sign up for GitHub

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

Jump to bottom

Scaladoc: Unescaped special characters in Quotes documentation #14377

Merged
merged 1 commit into from
Feb 7, 2022
Merged

Scaladoc: Unescaped special characters in Quotes documentation #14377

merged 1 commit into from
Feb 7, 2022

Conversation

KacperFKorban
Copy link
Member

closes #13746

image

@pikinier20 could you check if HTML formatting doesn't break?

@pikinier20
Copy link
Contributor

You could create a branch with scaladoc/ prefix. That would automatically upload a documentation snapshot to Azure

@KacperFKorban
Copy link
Member Author

@pikinier20 https://scala3docstorage.blob.core.windows.net/pr-fix-i13746/scala3/api/index.html

pikinier20
pikinier20 reviewed Feb 2, 2022
View reviewed changes
scaladoc/test/dotty/tools/scaladoc/signatures/TranslatableSignaturesTestCases.scala
Comment on lines +95 to +96

class MarkdownCode extends SignatureTest("markdowncode", SignatureTest.all)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK this test checks only signatures, it doesn't check comment contents.

pikinier20
pikinier20 approved these changes Feb 2, 2022
View reviewed changes
Copy link
Contributor

@pikinier20 pikinier20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So basically, it's a workaround for wiki syntax because we ignore backticks and render everything as a normal text. Tbh, I've looked once at this issue but didn't want to touch wiki parser so this solution is probably good enough.

@pikinier20 pikinier20 merged commit 064c213 into scala:main Feb 7, 2022
@Kordyjan Kordyjan added this to the 3.1.3 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pikinier20 pikinier20 pikinier20 approved these changes

Assignees

@pikinier20 pikinier20

Labels
None yet
Projects
None yet
Milestone
3.1.3
Development

Successfully merging this pull request may close these issues.

Scaladoc: Unescaped special characters in Quotes documentation
3 participants
@KacperFKorban @pikinier20 @Kordyjan