diff --git a/fearless_simd/README.md b/fearless_simd/README.md index 6ecce2bb..35f84d6e 100644 --- a/fearless_simd/README.md +++ b/fearless_simd/README.md @@ -143,9 +143,7 @@ hardware-specific intrinsics only when necessary. ### The `#[simd]` annotation -Fearless SIMD requires functions that use SIMD to be annotated with the `#[simd]` attribute from the `fearless_simd_macros` crate. Without it the code will still compile, but run far slower, defeating the purpose of SIMD. - -Use [`dispatch!`] when calling SIMD code from non-SIMD code. +It is recommended to annotate functions that use SIMD with the `#[simd]` attribute from the `fearless_simd_macros` crate. Without it the code will still compile, but requires special care to achieve full performance. If you cannot use proc macros, [you can achieve the same effect manually](https://github.com/linebender/fearless_simd/blob/main/fearless_simd/MANUAL_INLINING.md), but it requires some care. The use of `#[simd]` is recommended as the more robust and ergonomic option. diff --git a/fearless_simd/src/lib.rs b/fearless_simd/src/lib.rs index f1250d6a..72194fe2 100644 --- a/fearless_simd/src/lib.rs +++ b/fearless_simd/src/lib.rs @@ -110,9 +110,7 @@ //! //! ## The `#[simd]` annotation //! -//! Fearless SIMD requires functions that use SIMD to be annotated with the `#[simd]` attribute from the `fearless_simd_macros` crate. Without it the code will still compile, but run far slower, defeating the purpose of SIMD. -//! -//! Use [`dispatch!`] when calling SIMD code from non-SIMD code. +//! It is recommended to annotate functions that use SIMD with the `#[simd]` attribute from the `fearless_simd_macros` crate. Without it the code will still compile, but requires special care to achieve full performance. //! //! If you cannot use proc macros, [you can achieve the same effect manually](https://github.com/linebender/fearless_simd/blob/main/fearless_simd/MANUAL_INLINING.md), but it requires some care. The use of `#[simd]` is recommended as the more robust and ergonomic option. //!