Closed LVMVRQUXL closed 8 months ago
[!IMPORTANT] This is an incompatible source and binary change. See our versioning strategy for more details on when this change can be released.
Like commented in https://github.com/kotools/types/issues/586#issuecomment-2015469697, we want to remove the regex experimental property from the EmailAddress.Companion type for hiding implementation details.
regex
EmailAddress.Companion
// Actual EmailAddress.regex // compilation passes // Expected EmailAddress.regex // compilation fails
Finally, we should also indicate the pattern used for validating email addresses in the documentation of the create and the createOrNull functions.
create
createOrNull
Removing this property will add documentation redundancy in the factory functions of the EmailAddress type. So we will not resolve this issue.
EmailAddress
📝 Description
Like commented in https://github.com/kotools/types/issues/586#issuecomment-2015469697, we want to remove the
regex
experimental property from theEmailAddress.Companion
type for hiding implementation details.Finally, we should also indicate the pattern used for validating email addresses in the documentation of the
create
and thecreateOrNull
functions.✅ Checklist
create
function's documentation.createOrNull
function's documentation.