mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Validate generating docs (rust-lang/portable-simd#407)

Browse Source 
- Generate docs with warnings disabled.
- Instruct doctest to add `#![deny(warnings)]` to all tests.
This commit is contained in:
Daniel Paoliello 2024-03-22 16:08:24 -07:00 committed by GitHub
parent 53de3f0806
commit cff979eec1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.github/workflows/ci.yml vendored
View File

@ -141,6 +141,11 @@ jobs:
- name: Test (release) - name: Test (release)
run: cargo test --verbose --target=${{ matrix.target }} --release run: cargo test --verbose --target=${{ matrix.target }} --release
- name: Generate docs
run: cargo doc --verbose --target=${{ matrix.target }}
env:
RUSTDOCFLAGS: -Dwarnings
wasm-tests: wasm-tests:
name: "wasm (firefox, ${{ matrix.name }})" name: "wasm (firefox, ${{ matrix.name }})"
runs-on: ubuntu-latest runs-on: ubuntu-latest

1
crates/core_simd/src/lib.rs
View File

@ -40,6 +40,7 @@
)] )]
#![warn(missing_docs, clippy::missing_inline_in_public_items)] // basically all items, really #![warn(missing_docs, clippy::missing_inline_in_public_items)] // basically all items, really
#![deny(unsafe_op_in_unsafe_fn, clippy::undocumented_unsafe_blocks)] #![deny(unsafe_op_in_unsafe_fn, clippy::undocumented_unsafe_blocks)]
#![doc(test(attr(deny(warnings))))]
#![allow(internal_features)] #![allow(internal_features)]
#![unstable(feature = "portable_simd", issue = "86656")] #![unstable(feature = "portable_simd", issue = "86656")]
//! Portable SIMD module. //! Portable SIMD module.

6
crates/core_simd/src/vector.rs
View File

@ -325,7 +325,7 @@ pub fn copy_to_slice(self, slice: &mut [T]) {
/// # #![feature(portable_simd)] /// # #![feature(portable_simd)]
/// # #[cfg(feature = "as_crate")] use core_simd::simd; /// # #[cfg(feature = "as_crate")] use core_simd::simd;
/// # #[cfg(not(feature = "as_crate"))] use core::simd; /// # #[cfg(not(feature = "as_crate"))] use core::simd;
/// # use simd::{Simd, Mask}; /// # use simd::Simd;
/// let vec: Vec<i32> = vec![10, 11]; /// let vec: Vec<i32> = vec![10, 11];
/// ///
/// let result = Simd::<i32, 4>::load_or_default(&vec); /// let result = Simd::<i32, 4>::load_or_default(&vec);
@ -348,7 +348,7 @@ pub fn load_or_default(slice: &[T]) -> Self
/// # #![feature(portable_simd)] /// # #![feature(portable_simd)]
/// # #[cfg(feature = "as_crate")] use core_simd::simd; /// # #[cfg(feature = "as_crate")] use core_simd::simd;
/// # #[cfg(not(feature = "as_crate"))] use core::simd; /// # #[cfg(not(feature = "as_crate"))] use core::simd;
/// # use simd::{Simd, Mask}; /// # use simd::Simd;
/// let vec: Vec<i32> = vec![10, 11]; /// let vec: Vec<i32> = vec![10, 11];
/// let or = Simd::from_array([-5, -4, -3, -2]); /// let or = Simd::from_array([-5, -4, -3, -2]);
/// ///
@ -695,7 +695,7 @@ pub unsafe fn store_select_unchecked(
/// ///
/// # Safety /// # Safety
/// ///
/// Memory addresses for element are calculated [`core::ptr::wrapping_offset`] and /// Memory addresses for element are calculated [`pointer::wrapping_offset`] and
/// each enabled element must satisfy the same conditions as [`core::ptr::write`]. /// each enabled element must satisfy the same conditions as [`core::ptr::write`].
#[inline] #[inline]
pub unsafe fn store_select_ptr(self, ptr: *mut T, enable: Mask<<T as SimdElement>::Mask, N>) { pub unsafe fn store_select_ptr(self, ptr: *mut T, enable: Mask<<T as SimdElement>::Mask, N>) {