Fix broken code elements in docs #4292
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Coverage Report 1Affected Products
Test Logs |
Size Report 1Affected Products
Test Logs |
rlazo
approved these changes
Nov 8, 2022
davidmotson
pushed a commit
that referenced
this pull request
Nov 28, 2022
* Fix code blocks * Fix linting in firebase-database * Fix FirebaseMLDownloader linting
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per b/257286586, this PR fixes an issue where our docs were producing broken code elements.
This happens mainly because break elements are not supported by Dokka (see Kotlin/dokka#2262). To fix this, we just replace the code elements with pre elements- which is what we should be doing anyhow.
Note that is only a concern for multi-line code elements. Those that are single lined are fine as is (although this PR does fix one or two that were not correctly whitespaced).