lint corrections

Author: ABouttefeux

.github/workflows/benches.yml

@@ -12,8 +12,8 @@ jobs:
   bench:
     name: Run checks for Lattice QCD rs
     runs-on: ubuntu-latest
-    env:
-      CRITERION_TOKEN: ${{ secrets.CRITERION_TOKEN }}
+    # env:
+    #   CRITERION_TOKEN: ${{ secrets.CRITERION_TOKEN }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -25,7 +25,7 @@ jobs:
         run: |
           # run benchmarks and save baseline in a directory called "new"
           cargo bench
-      - name: Upload benchmarks
-        run: |
-          # upload the files
-          bash <(curl -s https://criterion.dev/bash)
+      # - name: Upload benchmarks
+      #   run: |
+      #     # upload the files
+      #     bash <(curl -s https://criterion.dev/bash)

.github/workflows/coverage.yml

@@ -29,8 +29,8 @@ jobs:
         run: |
           export RUSTFLAGS="-Zinstrument-coverage"
           export RUSTDOCFLAGS="-Zinstrument-coverage -Zunstable-options --persist-doctests target/debug/doctestbins"
-          cargo +nightly build --verbose --all --features="no-overflow-test","serde-serialize"
-          LLVM_PROFILE_FILE="lattice_qcd_rs-%p-%m.profraw" cargo +nightly test --verbose --features="no-overflow-test","serde-serialize" --workspace --exclude lattice_qcd_rs-procedural_macro
+          cargo +nightly build --verbose --all --no-default-features --features="serde-serialize"
+          LLVM_PROFILE_FILE="lattice_qcd_rs-%p-%m.profraw" cargo +nightly test --verbose --no-default-features --features="serde-serialize" --workspace --exclude lattice_qcd_rs-procedural_macro
 
       - name: parse code coverage
         run: ./grcov . --binary-path ./target/debug/ -s . -t lcov --branch --ignore-not-existing --ignore "/*" -o lcov.info

.github/workflows/rust.yml

@@ -32,7 +32,7 @@ jobs:
       run: cargo test --all --verbose --features serde-serialize
 
     - name: Build no features
-      run: cargo build --all --verbose --no-default-features
+      run: cargo build --all --verbose --no-default-features --features overflow-test
 
     - name: Run tests no features
-      run: cargo test --all --verbose --no-default-features
+      run: cargo test --all --verbose --no-default-features --features overflow-test

.github/workflows/rust_beta.yml

@@ -28,7 +28,7 @@ jobs:
       run: cargo test --all --verbose --features serde-serialize
 
     - name: Build beta no features
-      run: cargo build --all --verbose --no-default-features
+      run: cargo build --all --verbose --no-default-features --features overflow-test
 
     - name: Run tests beta no features
-      run: cargo test --all --verbose --no-default-features
+      run: cargo test --all --verbose --no-default-features --features overflow-test

.gitignore

@@ -11,3 +11,4 @@ Cargo.lock
 data/
 .vscode/settings.json
 logo.png
+rust-toolchain.toml

CHANGELOG.md

@@ -1,8 +1,14 @@
 
 # v0.3.0
 
+## breaking changes
+- [`SymplecticEulerError`](https://abouttefeux.github.io/lattice-qcd-rs/lattice_qcd_rs/integrator/symplectic_euler/enum.SymplecticEulerError.html) is now marked `#[non_exhaustive]`
+- change the feature "no-overflow-test" to "overflow-test" and enabling "overflow-test" by default
+
+## non breaking
 - update dependencies
 - remove the extern crate declaration in lib.rs
+- correct documentation
 
 # v0.2.1
 

Cargo.toml

@@ -10,20 +10,24 @@ description = "Lattice QCD simulation"
 keywords = ["QCD", "Lattice", "Monte-Carlo", "chromodynamics"]
 publish = true
 license = "MIT OR Apache-2.0"
-rust-version = "1.61"
+rust-version = "1.72"
+
 
 [lib]
 path = "src/lib.rs"
 crate-type = ["lib"]
 
+
 [features]
 serde-serialize = ["dep:serde", "nalgebra/serde-serialize"]
-no-overflow-test = []
-default = ["serde-serialize"]
+overflow-test = []
+default = ["serde-serialize", "overflow-test"]
+
 
 [workspace]
 members = ["procedural_macro"]
 
+
 [dependencies]
 nalgebra = { version = "0.32", features = ["serde-serialize"] }
 approx = "0.5.1"
@@ -35,15 +39,18 @@ rayon = "1.7"
 serde = { version = "1.0", features = ["derive"], optional = true }
 lattice_qcd_rs-procedural_macro = { path = "procedural_macro", version = "0.3.0" }
 
+
 [dev-dependencies]
 criterion = "0.5.1"
 version-sync = "0.9.4"
 
+
 [[bench]]
 name = "bench"
 path = "benches/bench.rs"
 harness = false
 
+
 [profile.test]
 opt-level = 2 # in order to have resonable test time
 

benches/bench.rs

@@ -199,7 +199,7 @@ fn criterion_benchmark(c: &mut Criterion) {
                     LatticeStateDefault::<4>::new_determinist(1_f64, 1_f64, *i, &mut rng).unwrap();
                 let d = rand_distr::Normal::new(0.0, 0.5_f64).unwrap();
                 let e_field = EField::new_determinist(state.lattice(), &mut rng, &d);
-                e_field.project_to_gauss(state.link_matrix(), state.lattice());
+                let _ = e_field.project_to_gauss(state.link_matrix(), state.lattice());
             })
         });
     }

clippy.toml

@@ -0,0 +1 @@
+avoid-breaking-exported-api = false

procedural_macro/Cargo.toml

@@ -3,10 +3,13 @@ name = "lattice_qcd_rs-procedural_macro"
 version = "0.3.0"
 authors = ["Aliénore Bouttefeux <alienore.bouttefeux@gmail.com>"]
 edition = "2021"
-description = "Set of procedural macro for the main library lattice_qcd_rs"
+readme = "README.md"
 repository = "https://github.com/ABouttefeux/lattice-qcd-rs/"
-license = "MIT OR Apache-2.0"
+categories = ["Science", "Simulation"]
+description = "Set of procedural macro for the main library lattice_qcd_rs"
+keywords = ["QCD", "Lattice", "Monte-Carlo", "chromodynamics", "macro"]
 publish = true
+license = "MIT OR Apache-2.0"
 
 [lib]
 proc-macro = true