updated docs

Author: jajapuramshivasai

.github/workflows/docs.yml

@@ -1,39 +1,45 @@
-name: Deploy Rust docs
+name: Docs
 
 on:
-  push:
-    branches: [ main ]
-  workflow_dispatch:
+	push:
+		branches:
+			- main
+	workflow_dispatch:
 
 permissions:
-  contents: read
-  pages: write
-  id-token: write
+	contents: read
+	pages: write
+	id-token: write
+
+concurrency:
+	group: pages
+	cancel-in-progress: true
 
 jobs:
-  build-and-deploy:
-    runs-on: macos-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    concurrency:
-      group: docs-pages
-      cancel-in-progress: true
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Install Rust
-        uses: dtolnay/rust-toolchain@stable
-
-      - name: Build docs
-        run: cargo doc --no-deps --workspace
-      - name: Prepare Pages artifact
-        run: touch target/doc/.nojekyll
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: target/doc
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+	build:
+		runs-on: ubuntu-latest
+		steps:
+			- name: Checkout
+				uses: actions/checkout@v4
+
+			- name: Install Rust
+				uses: dtolnay/rust-toolchain@stable
+
+			- name: Build documentation
+				run: cargo doc --no-deps
+
+			- name: Upload documentation
+				uses: actions/upload-pages-artifact@v3
+				with:
+					path: target/doc
+
+	deploy:
+		needs: build
+		runs-on: ubuntu-latest
+		environment:
+			name: github-pages
+			url: ${{ steps.deploy.outputs.page_url }}
+		steps:
+			- name: Deploy to GitHub Pages
+				id: deploy
+				uses: actions/deploy-pages@v4

src/lib.rs

@@ -79,11 +79,7 @@ impl Vector3 {
     /// Returns `self` unchanged if the magnitude is zero.
     pub fn normalized(self) -> Self {
         let mag = self.magnitude();
-        if mag == 0.0 {
-            self
-        } else {
-            self / mag
-        }
+        if mag == 0.0 { self } else { self / mag }
     }
 }
 
@@ -259,7 +255,10 @@ where
         magnetization.push(m);
     }
 
-    SimulationResult { times, magnetization }
+    SimulationResult {
+        times,
+        magnetization,
+    }
 }
 
 #[cfg(test)]
@@ -303,7 +302,10 @@ mod tests {
 
         for m in result.magnetization {
             let norm = m.magnitude();
-            assert!((norm - 1.0).abs() < 5e-4, "magnetization norm drifted: {norm}");
+            assert!(
+                (norm - 1.0).abs() < 5e-4,
+                "magnetization norm drifted: {norm}"
+            );
         }
     }
 
@@ -319,6 +321,9 @@ mod tests {
         });
 
         let final_state = *result.magnetization.last().unwrap();
-        assert!(final_state.z > 0.99, "spin failed to align with field: {final_state:?}");
+        assert!(
+            final_state.z > 0.99,
+            "spin failed to align with field: {final_state:?}"
+        );
     }
 }