From f88cf6836bd47eb5b845233cbdb01e9afad4b4f5 Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Sun, 13 Nov 2022 22:22:50 -0700 Subject: [PATCH] Use `include_str!` for `.md` inclusion in rustdoc (#434) Previously a now-removed nightly-only feature was used, but now that it's stable, `include_str!` can be used for all of these cases. --- src/backend/vector/avx2/mod.rs | 2 +- src/backend/vector/ifma/mod.rs | 2 +- src/backend/vector/mod.rs | 6 +----- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/src/backend/vector/avx2/mod.rs b/src/backend/vector/avx2/mod.rs index 420afaf..b3e2d14 100644 --- a/src/backend/vector/avx2/mod.rs +++ b/src/backend/vector/avx2/mod.rs @@ -9,7 +9,7 @@ // - isis agora lovecruft // - Henry de Valence -#![cfg_attr(feature = "nightly", doc(include = "../../../../docs/avx2-notes.md"))] +#![doc = include_str!("../../../../docs/avx2-notes.md")] pub(crate) mod field; diff --git a/src/backend/vector/ifma/mod.rs b/src/backend/vector/ifma/mod.rs index 33cd4d9..dbfc2dd 100644 --- a/src/backend/vector/ifma/mod.rs +++ b/src/backend/vector/ifma/mod.rs @@ -7,7 +7,7 @@ // Authors: // - Henry de Valence -#![cfg_attr(feature = "nightly", doc(include = "../../../../docs/ifma-notes.md"))] +#![doc = include_str!("../../../../docs/ifma-notes.md")] pub mod field; diff --git a/src/backend/vector/mod.rs b/src/backend/vector/mod.rs index 29a6f65..1763899 100644 --- a/src/backend/vector/mod.rs +++ b/src/backend/vector/mod.rs @@ -9,11 +9,7 @@ // - isis agora lovecruft // - Henry de Valence -// Conditionally include the notes if we're on nightly (so we can include docs at all). -#![cfg_attr( - feature = "nightly", - doc(include = "../../../docs/parallel-formulas.md") -)] +#![doc = include_str!("../../../docs/parallel-formulas.md")] #[cfg(not(any(target_feature = "avx2", target_feature = "avx512ifma", rustdoc)))] compile_error!("simd_backend selected without target_feature=+avx2 or +avx512ifma");