[ai-completion] ML-3369 Improve deprecation annotation of isCurrentlyDisplaying

GitOrigin-RevId: 379729d9dbe94dc32b62b7fc649a84a09f09be70
This commit is contained in:
Petr Surkov
2024-06-04 20:50:10 +00:00
committed by intellij-monorepo-bot
parent fcc7f7ba51
commit 196334d66b
@@ -57,7 +57,11 @@ sealed class InlineCompletionEventType {
*/
class Hide @ApiStatus.Internal constructor(
val finishType: FinishType,
@Deprecated("This value is incorrect sometimes. Use Show event to determine if completion was shown")
@Deprecated("""
This value delegates to InlineCompletionContext.isCurrentlyDisplaying().
In cases of invalidation (e.g., mismatched typing), the context is already cleared, causing the method to return false,
which can be misleading.
Please use other methods of the listener to determine whether completion is or was being shown.""")
val isCurrentlyDisplaying: Boolean
) : InlineCompletionEventType()