Tidy Range matchers #4081
Tidy Range matchers #4081
Conversation
- Remove `@OptIn(ExperimentalStdlibApi::class)` now that Ranges are stable
- `@Suppress("UNCHECKED_CAST")` when casting ranges
- Use `@PublishedApi` instead of `@Suppress("NON_PUBLIC_CALL_FROM_PUBLIC_INLINE")`.
- Update kdoc to fix typos.
- Remove `If you need to check for empty range, use [ClosedRange.shouldBeEmpty]` from kdoc - no such function exists.
There was a problem hiding this comment.
I thought I could annotate the @PublishedApi functions with @KotestInternal to avoid updating the ABI dumps, but I see that @KotestInternal isn't excluded from the ABI dumps. Shouldn't it be?
Lines 13 to 21 in d4fc582
There was a problem hiding this comment.
AFAIK there's no way to exclude API with a particular annotation. Or is it?
There was a problem hiding this comment.
There is:
apiValidation {
/**
* Set of annotations that exclude API from being public.
* Typically, it is all kinds of `@InternalApi` annotations that mark
* effectively private API that cannot be actually private for technical reasons.
*/
nonPublicMarkers.add("my.package.MyInternalApiAnnotation")
}There was a problem hiding this comment.
Agreed! I think it's a good idea
There was a problem hiding this comment.
Created separate issue for tracking that. Do you want to proceed with that before finishing up this PR, or should we look into merging this one as-is?
There was a problem hiding this comment.
Nice, thanks.
Let's merge this one as-is.
| (this.end.edgeType== RangeEdgeType.INCLUSIVE && other.start.edgeType == RangeEdgeType.INCLUSIVE) -> (endOfThis < startOfOther) | ||
| else -> (endOfThis <= startOfOther) | ||
| (this.end.edgeType == RangeEdgeType.INCLUSIVE && other.start.edgeType == RangeEdgeType.INCLUSIVE) -> (endOfThis < startOfOther) | ||
| else -> (endOfThis <= startOfOther) |
There was a problem hiding this comment.
What formatting rule is this? I don't think it's one we typically apply in this project :)
There was a problem hiding this comment.
Oh oops, I must have used my default formatter! I enabled 'align when branches in columns'.
Thanks for checking, I'll fix my config.
@OptIn(ExperimentalStdlibApi::class)now that Ranges are stable@Suppress("UNCHECKED_CAST")when casting ranges@PublishedApiinstead of@Suppress("NON_PUBLIC_CALL_FROM_PUBLIC_INLINE").@PublishedApiare technically part of the public ABI.If you need to check for empty range, use [ClosedRange.shouldBeEmpty]from kdoc - no such function exists.