Improve KDoc on ActivityLifecycleEvent by explaining ordering semantics.
#586
Conversation
This file contains 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
psteiger
force-pushed
the
android-docs
branch
2 times, most recently
from
bfcb313 to
5d21e2c
Compare
Also, a couple of minor fixes: - A small warning on `RibActivity` against importing `android.R`. - Replaces deprecated `String.toLowerCase()` and `String.capitalize()` with the equivalent `String.lowercase()` and `String.replaceFirstChar(Char::titlecase)`.
psteiger
changed the title
ActivityLifecycleEvent explaining ordering semantics.ActivityLifecycleEvent by explaining ordering semantics.
tyvsmith
reviewed
May 16, 2023
| * | ||
| * The equality does not hold: | ||
| * ``` | ||
| * assertThat(a == b).isFalse() |
There was a problem hiding this comment.
IMO, no, because Android bundles also do not implement equals. From its Javadoc:
Warning: Note that [Bundle](https://developer.android.com/reference/android/os/Bundle) is a lazy container
and as such it does NOT implement
[Object.equals(java.lang.Object)](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))
or [Object.hashCode()](https://developer.android.com/reference/java/lang/Object#hashCode()).
tyvsmith
reviewed
May 16, 2023
| @@ -79,7 +109,7 @@ private constructor( | |||
| Type.DESTROY -> DESTROY_EVENT | |||
| else -> | |||
| throw IllegalArgumentException( | |||
| "Use the createOn${type.name.toLowerCase().capitalize()}Event() method for this type!", | |||
| "Use the createOn${type.name.lowercase().replaceFirstChar(Char::titlecase)}Event() method for this type!", | |||
There was a problem hiding this comment.
Kind of surprised they replaced capitalize with this, it's much more verbose and less obvious for folks.
There was a problem hiding this comment.
Actually the drop in replacement is even more verbose (suggested by ReplaceWith):
replaceFirstChar { if (it.isLowerCase()) it.titlecase(locale) else it.toString() }From googling It, it seems the original deprecated capitalize function had issues with
- Not taking a locale (deprecated in favor of
capitalize(Locale) capitalize(Locale)is also deprecated, because of surprising behavior on characters that are one char in Unicode, but actually two chars in the natural language.
Both of which don't matter at this particular call site of ours
tyvsmith
approved these changes
May 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Also, a couple of minor fixes:
RibActivityagainst importingandroid.R.String.toLowerCase()andString.capitalize()with the equivalentString.lowercase()andString.replaceFirstChar(Char::titlecase).