Remove unclear warning in AsyncImagePainter docs. (#2711)

coil-kt · Nov 22, 2024 · e188a3d · e188a3d
1 parent cff22db
commit e188a3d
Show file tree

Hide file tree

Showing 2 changed files with 0 additions and 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
@@ -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
@@ -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].