Modify contributing md scripts to solve conflicts between doc and scr…

…ipts (#2107)

* modified scripts comments and contributing.md to solve conflicts between them

* modified default value for checktypes and added NoArgs enum value

* added burn tch installation link

* Removed NoArgs enum value and use All as default

CONTRIBUTING.md

@@ -94,7 +94,7 @@ You may also want to enable debugging by creating a `.vscode/settings.json` file
 On Unix systems, run `run-checks.sh` using this command
 
 ```
-run-checks.sh environment
+./run-checks.sh environment
 ```
 
 On Windows systems, run `run-checks.ps1` using this command:
@@ -106,9 +106,12 @@ run-checks.ps1 environment
 The `environment` argument can assume **ONLY** the following values:
 
 - `std` to perform checks using `libstd`
-- `no_std` to perform checks on an embedded environment using `libcore`
+- `no-std` to perform checks on an embedded environment using `libcore`
+- `typos` to check for typos in the codebase
+- `examples` to check the examples compile
 
-If no `environment` value has been passed, run both `std` and `no_std` checks.
+If no `environment` value has been passed, run all checks except examples.
+If you have an error related to `torch` installation, see [Burn Torch Backend Installation](./crates/burn-tch/README.md#Installation)
 
 ## Continuous Deployment
 

run-checks.ps1

@@ -8,7 +8,7 @@
 # where `environment` can assume **ONLY** the following values:
 #
 # - `std` to perform checks using `libstd`
-# - `no_std` to perform checks on an embedded environment using `libcore`
+# - `no-std` to perform checks on an embedded environment using `libcore`
 # - `typos` to check for typos in the codebase
 # - `examples` to check the examples compile
 # If no `environment` value has been passed, run all checks except examples.

run-checks.sh

@@ -13,7 +13,7 @@ set -e
 # where `environment` can assume **ONLY** the following values:
 #
 # - `std` to perform checks using `libstd`
-# - `no_std` to perform checks on an embedded environment using `libcore`
+# - `no-std` to perform checks on an embedded environment using `libcore`
 # - `typos` to check for typos in the codebase
 # - `examples` to check the examples compile
 #

xtask/src/main.rs

@@ -35,6 +35,7 @@ enum Command {
     /// Run the specified `burn` tests and checks locally.
     RunChecks {
         /// The environment to run checks against
+        #[clap(value_enum, default_value_t = runchecks::CheckType::default())]
         env: runchecks::CheckType,
     },
     /// Run the specified vulnerability check locally. These commands must be called with 'cargo +nightly'.

xtask/src/runchecks.rs

@@ -25,7 +25,7 @@ const ARM_TARGET: &str = "thumbv7m-none-eabi";
 
 #[derive(clap::ValueEnum, Default, Copy, Clone, PartialEq, Eq)]
 pub(crate) enum CheckType {
-    /// Run all checks.
+    /// Run all checks except examples
     #[default]
     All,
     /// Run `std` environment checks
@@ -51,7 +51,7 @@ impl CheckType {
         // Depending on the input argument, the respective environment checks
         // are run.
         //
-        // If no environment has been passed, run all checks.
+        // If no `environment` value has been passed, run all checks except examples.
         match self {
             Self::Std => std_checks(),
             Self::NoStd => no_std_checks(),
@@ -62,7 +62,6 @@ impl CheckType {
                 check_typos();
                 std_checks();
                 no_std_checks();
-                check_examples();
             }
         }