Browse Source

ci: also run doc tests

cargo nextest still can't run doctests.
Philipp Schuster 8 months ago
parent
commit
4888d5576d
3 changed files with 5 additions and 16 deletions
  1. 2 13
      .github/workflows/_build-rust.yml
  2. 1 0
      multiboot2/Changelog.md
  3. 2 3
      multiboot2/src/lib.rs

+ 2 - 13
.github/workflows/_build-rust.yml

@@ -94,19 +94,8 @@ jobs:
         run: |
           cargo doc --no-deps --document-private-items --features ${{ inputs.features }} --no-default-features
           cargo clippy --all-targets --features ${{ inputs.features }} --no-default-features
-      - name: Unit Test (UNIX)
-        if: inputs.do-test && runner.os != 'Windows'
-        run: |
-          curl -LsSf https://get.nexte.st/latest/linux | tar zxf -
-          chmod u+x cargo-nextest
-          ./cargo-nextest nextest run --features ${{ inputs.features }} --no-default-features
-      - name: Unit Test (Windows)
-        if: inputs.do-test && runner.os == 'Windows'
-        run: |
-          Invoke-WebRequest https://get.nexte.st/latest/windows -OutFile cargo-nextest.zip
-          Expand-Archive .\cargo-nextest.zip
-          cp .\cargo-nextest/cargo-nextest.exe .
-          .\cargo-nextest.exe nextest run --features ${{ inputs.features }} --no-default-features
+      - name: Unit Test
+        run: cargo test --verbose
       - name: Unit Test with Miri
         if: inputs.do-miri
         # "--tests" so that the doctests are skipped. Currently, the doctest

+ 1 - 0
multiboot2/Changelog.md

@@ -4,6 +4,7 @@
 
 - updated dependencies
 - MSRV is 1.75
+- doc fixes
 
 ## 0.20.2 (2024-05-26)
 

+ 2 - 3
multiboot2/src/lib.rs

@@ -424,8 +424,7 @@ impl<'a> BootInformation<'a> {
     /// special handling is required. This is reflected by code-comments.
     ///
     /// ```no_run
-    /// use std::str::Utf8Error;
-    /// use multiboot2::{BootInformation, BootInformationHeader, Tag, TagTrait, TagType, TagTypeId};
+    /// use multiboot2::{BootInformation, BootInformationHeader, StringError, Tag, TagTrait, TagType, TagTypeId};
     ///
     /// #[repr(C)]
     /// #[derive(multiboot2::Pointee)] // Only needed for DSTs.
@@ -449,7 +448,7 @@ impl<'a> BootInformation<'a> {
     /// }
     ///
     /// impl CustomTag {
-    ///     fn name(&self) -> Result<&str, Utf8Error> {
+    ///     fn name(&self) -> Result<&str, StringError> {
     ///         Tag::parse_slice_as_string(&self.name)
     ///     }
     /// }