saymrwulf/curve25519-dalek-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/curve25519-dalek-source.git synced 2026-09-04 20:24:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use include_str! for .md inclusion in rustdoc (#434)

Browse source 
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.
This commit is contained in:
Tony Arcieri 2022-11-13 22:22:50 -07:00 committed by GitHub
parent d05afa02a3
commit f88cf6836b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/backend/vector/avx2/mod.rs
View file

@ -9,7 +9,7 @@
// - isis agora lovecruft <isis@patternsinthevoid.net>
// - Henry de Valence <hdevalence@hdevalence.ca>
#![cfg_attr(feature = "nightly", doc(include = "../../../../docs/avx2-notes.md"))]
#![doc = include_str!("../../../../docs/avx2-notes.md")]
pub(crate) mod field;

2
src/backend/vector/ifma/mod.rs
View file

@ -7,7 +7,7 @@
// Authors:
// - Henry de Valence <hdevalence@hdevalence.ca>
#![cfg_attr(feature = "nightly", doc(include = "../../../../docs/ifma-notes.md"))]
#![doc = include_str!("../../../../docs/ifma-notes.md")]
pub mod field;

6
src/backend/vector/mod.rs
View file

@ -9,11 +9,7 @@
// - isis agora lovecruft <isis@patternsinthevoid.net>
// - Henry de Valence <hdevalence@hdevalence.ca>
// 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");