docs: Fix internal intra-doc links

Author: jan-ferdinand

.github/workflows/main.yml

@@ -14,34 +14,37 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-      - name: Checkout sources
-        uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          profile: minimal
-          toolchain: stable
-          override: true
           components: rustfmt, clippy
 
-      - name: Run cargo fmt
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+      - name: Install nextest
+        uses: taiki-e/install-action@nextest
 
-      - name: Run cargo clippy
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: --all-targets -- -D warnings
+      - name: Run fmt
+        run: cargo fmt --all -- --check
 
-      - name: Run cargo test without benches
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: -- --skip benches
+      - name: Build documentation
+        run: cargo doc --no-deps --workspace --document-private-items
+        env:
+          RUSTDOCFLAGS: -D warnings
+
+      - name: Run clippy
+        run: cargo clippy --all-targets -- -D warnings
+
+      - name: Run tests
+        run: cargo nextest run --no-fail-fast -- --skip benches
+
+        # doctests are special [^1] but this step does not incur a performance penalty [^2]
+        #
+        # [^1]: https://nexte.st/book/usage.html#limitations
+        # [^2]: https://github.com/nextest-rs/nextest/issues/16
+      - name: Run documentation tests
+        run: cargo test --doc

tasm-lib/src/arithmetic/u128/overflowing_add.rs

@@ -8,7 +8,8 @@ pub struct OverflowingAdd;
 impl OverflowingAdd {
     /// Generate code to perform an addition on `u128`s.
     ///
-    /// This function is called by both this snippet and [`SafeAdd`].
+    /// This function is called by both this snippet and
+    /// [`SafeAdd`](super::safe_add::SafeAdd).
     ///
     /// BEFORE: _ rhs_3 rhs_2 rhs_1 rhs_0 lhs_3 lhs_2 lhs_1 lhs_0
     /// AFTER:  _ sum_3 sum_2 sum_1 sum_0 is_overflow

tasm-lib/src/verifier/vm_proof_iter/dequeue_next_as.rs

@@ -244,12 +244,13 @@ impl DequeueNextAs {
         triton_asm! { push {bookkeeping_offset} hint bookkeeping_offset = stack[0] add }
     }
 
-    /// A `BFielcCodec`` encoding of a `Polynomial<T>` may not contain trailing zeros. This is
-    /// because it must be easy to read the degree of the polynomial. In order to be consistent with
-    /// that rule, we perform this check here, before returning a pointer to the polynomial to the
-    /// caller.
+    /// A [`BFieldCodec`] encoding of a [`Polynomial`] may not contain trailing
+    /// zeros. This is because it must be easy to read the degree of the polynomial.
+    /// In order to be consistent with that rule, we perform this check here, before
+    /// returning a pointer to the polynomial to the caller.
+    ///
     /// ```text
-    /// BEFORE:  _ *proof_item_payload
+    /// BEFORE: _ *proof_item_payload
     /// AFTER:  _ *proof_item_payload
     /// ```
     fn verify_last_xfe_is_non_zero_if_payload_is_polynomial(&self) -> Vec<LabelledInstruction> {

tasm-object-derive/src/lib.rs

@@ -84,7 +84,8 @@ struct ParsedStruct {
 
     /// The types of all relevant fields. Notably, ignored fields are _not_ included.
     ///
-    /// The order of the entries mimics the order of field [`field_names`].
+    /// The order of the entries mimics the order of field
+    /// [`field_names`](Self::field_names).
     field_types: Vec<syn::Type>,
 
     ignored_fields: Vec<syn::Field>,