replace MIPS with Miri for cross endian tests

.github/workflows/rust.yml

@@ -84,18 +84,19 @@ jobs:
           cd ./tests/smoke-test
           cargo +$msrv build
 
-  mips:
-    name: Tests / MIPS (Big Endian)
+  miri:
+    name: "Miri"
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout sources
-        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
-
-      - name: Install Cross
-        run: cargo install cross
-
+      - uses: actions/checkout@v3
+      - name: Install Miri
+        run: |
+          rustup toolchain install nightly --component miri
+          cargo +nightly miri setup
       - name: Default features
-        run: cross test --target mips-unknown-linux-gnu
+        run: cargo +nightly miri test
+      - name: BE
+        run: cargo +nightly miri test --target s390x-unknown-linux-gnu
 
   clippy:
     name: Clippy

README.md

@@ -46,11 +46,17 @@ use bitflags::bitflags;
 
 // The `bitflags!` macro generates `struct`s that manage a set of flags.
 bitflags! {
+    /// Represents a set of flags.
     #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
     struct Flags: u32 {
+        /// The value `A`, at bit position `0`.
         const A = 0b00000001;
+        /// The value `B`, at bit position `1`.
         const B = 0b00000010;
+        /// The value `C`, at bit position `2`.
         const C = 0b00000100;
+
+        /// The combination of `A`, `B`, and `C`.
         const ABC = Self::A.bits() | Self::B.bits() | Self::C.bits();
     }
 }