From 2a99f73682700f33500e660f5143c0610e8b95dc Mon Sep 17 00:00:00 2001 From: Colin White Date: Fri, 22 Nov 2024 10:48:49 -0800 Subject: [PATCH] Remove unclear warning in AsyncImagePainter docs. --- .../src/commonMain/kotlin/coil3/compose/AsyncImagePainter.kt | 4 ---- .../kotlin/coil3/compose/SingletonAsyncImagePainter.kt | 4 ---- 2 files changed, 8 deletions(-) diff --git a/coil-compose-core/src/commonMain/kotlin/coil3/compose/AsyncImagePainter.kt b/coil-compose-core/src/commonMain/kotlin/coil3/compose/AsyncImagePainter.kt index 1a6e92605d..c3d37f443f 100644 --- a/coil-compose-core/src/commonMain/kotlin/coil3/compose/AsyncImagePainter.kt +++ b/coil-compose-core/src/commonMain/kotlin/coil3/compose/AsyncImagePainter.kt @@ -60,8 +60,6 @@ import kotlinx.coroutines.launch /** * Return an [AsyncImagePainter] that executes an [ImageRequest] asynchronously and renders the result. * - * ** This is a lower-level API than [AsyncImage] and may not work as expected in all situations. ** - * * @param model Either an [ImageRequest] or the [ImageRequest.data] value. * @param imageLoader The [ImageLoader] that will be used to execute the request. * @param placeholder A [Painter] that is displayed while the image is loading. @@ -100,8 +98,6 @@ fun rememberAsyncImagePainter( /** * Return an [AsyncImagePainter] that executes an [ImageRequest] asynchronously and renders the result. * - * ** This is a lower-level API than [AsyncImage] and may not work as expected in all situations. ** - * * @param model Either an [ImageRequest] or the [ImageRequest.data] value. * @param imageLoader The [ImageLoader] that will be used to execute the request. * @param transform A callback to transform a new [State] before it's applied to the diff --git a/coil-compose/src/commonMain/kotlin/coil3/compose/SingletonAsyncImagePainter.kt b/coil-compose/src/commonMain/kotlin/coil3/compose/SingletonAsyncImagePainter.kt index 5525a4b6f9..8538cc0015 100644 --- a/coil-compose/src/commonMain/kotlin/coil3/compose/SingletonAsyncImagePainter.kt +++ b/coil-compose/src/commonMain/kotlin/coil3/compose/SingletonAsyncImagePainter.kt @@ -15,8 +15,6 @@ import coil3.request.ImageRequest /** * Return an [AsyncImagePainter] that executes an [ImageRequest] asynchronously and renders the result. * - * ** This is a lower-level API than [AsyncImage] and may not work as expected in all situations. ** - * * @param model Either an [ImageRequest] or the [ImageRequest.data] value. * @param placeholder A [Painter] that is displayed while the image is loading. * @param error A [Painter] that is displayed when the image request is unsuccessful. @@ -58,8 +56,6 @@ fun rememberAsyncImagePainter( /** * Return an [AsyncImagePainter] that executes an [ImageRequest] asynchronously and renders the result. * - * ** This is a lower-level API than [AsyncImage] and may not work as expected in all situations. ** - * * @param model Either an [ImageRequest] or the [ImageRequest.data] value. * @param transform A callback to transform a new [State] before it's applied to the * [AsyncImagePainter]. Typically this is used to overwrite the state's [Painter].