Remove code style from deprecated message #6753
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
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/crashlytics/KeyValueBuilder.html 2025-03-10 17:32:37.743727610 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/crashlytics/KeyValueBuilder.html 2025-03-10 17:30:04.300571136 +0000
@@ -96,7 +96,7 @@
<div class="api-item"><a name="KeyValueBuilder-com.google.firebase.crashlytics.FirebaseCrashlytics-"></a><a name="keyvaluebuilder"></a>
<h3 class="api-name" id="KeyValueBuilder(com.google.firebase.crashlytics.FirebaseCrashlytics)">KeyValueBuilder</h3>
<pre class="api-signature no-pretty-print">public <span><del><a href="/docs/reference/android/com/google/firebase/crashlytics/KeyValueBuilder.html#KeyValueBuilder(com.google.firebase.crashlytics.FirebaseCrashlytics)">KeyValueBuilder</a></del></span>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html">FirebaseCrashlytics</a> crashlytics)</pre>
- <aside class="caution"><strong>This method is deprecated.</strong><br>Do not construct this directly. Use [setCustomKeys] instead. To be removed in the next major release.</aside>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>Do not construct this directly. Use `setCustomKeys` instead. To be removed in the next major release.</aside>
</div>
</div>
<div class="list">--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/crashlytics/KeyValueBuilder.html 2025-03-10 17:32:37.741727597 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/crashlytics/KeyValueBuilder.html 2025-03-10 17:30:04.294571089 +0000
@@ -96,7 +96,7 @@
<div class="api-item"><a name="KeyValueBuilder-com.google.firebase.crashlytics.FirebaseCrashlytics-"></a><a name="keyvaluebuilder"></a>
<h3 class="api-name" id="KeyValueBuilder(com.google.firebase.crashlytics.FirebaseCrashlytics)">KeyValueBuilder</h3>
<pre class="api-signature no-pretty-print"><span><del><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/KeyValueBuilder.html#KeyValueBuilder(com.google.firebase.crashlytics.FirebaseCrashlytics)">KeyValueBuilder</a></del></span>(crashlytics: <a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html">FirebaseCrashlytics</a>)</pre>
- <aside class="caution"><strong>This function is deprecated.</strong><br>Do not construct this directly. Use [setCustomKeys] instead. To be removed in the next major release.</aside>
+ <aside class="caution"><strong>This function is deprecated.</strong><br>Do not construct this directly. Use `setCustomKeys` instead. To be removed in the next major release.</aside>
</div>
</div>
<div class="list"> |
Coverage Report 1Affected ProductsNo changes between base commit (a232b6d) and merge commit (bbcd3b2).Test Logs |
|
I assume you tried backticks? Did they just render as backticks? If they did (or if they made the string render as code font), can we add those? If they caused something to error or look funky, then we can just leave this as you have it in this PR. |
Test Results 8 files - 6 8 suites - 6 20s ⏱️ +8s Results for commit 1c8f219. ± Comparison against base commit a232b6d. This pull request removes 23 and adds 22 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Size Report 1Affected ProductsTest Logs |
I changed it back to backticks, they will render as backticks, not code font, but it doesn't look bad. |
rachelsaunders
approved these changes
Mar 10, 2025
# for free
to subscribe to this conversation on GitHub.
Already have an account?
#.
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.
Remove code style from deprecated message since it does not render properly. I could not find any syntax that rendered properly in both the IDE and in the generated html. I found many examples of deprecated messages that just don't add any code style to method or class names, see https://source.corp.google.com/search?q=%22@Deprecated(message%22. The Kotlin doc for
@Deprecateddoes not mention any style, see https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-deprecated/.