Skip to content

Commit b5f839a

Browse files
committed
Fixes kdoc typo on OverlayDialogHolder
1 parent d35c70d commit b5f839a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/OverlayDialogHolder.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ package com.squareup.workflow1.ui.container
22

33
import android.app.Dialog
44
import android.graphics.Rect
5-
import com.squareup.workflow1.ui.Screen
65
import com.squareup.workflow1.ui.ViewEnvironment
76
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
87
import com.squareup.workflow1.ui.compatible
@@ -23,11 +22,12 @@ public interface OverlayDialogHolder<in OverlayT : Overlay> {
2322
public val environment: ViewEnvironment
2423

2524
/**
26-
* The function that is run by [show] to update [dialog] with a new [Screen] rendering and
25+
* The function that is run by [show] to update [dialog] with a new [Overlay] rendering and
2726
* [ViewEnvironment].
2827
*
2928
* Prefer calling [show] to using this directly, to ensure that [overlayOrNull] is
30-
* maintained correctly, and [showing] keeps working.
29+
* maintained correctly, and [showing] keeps working. Or most commonly,
30+
* allow `WorkflowViewStub.show` to call it for you.
3131
*/
3232
public val runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit
3333

0 commit comments

Comments
 (0)