Fixed small lint problem and added a paragraph to the README

pull/68/head
Meliurwen 2 years ago
parent ccced92149
commit 2153f46758
Signed by: meliurwen
GPG Key ID: 818A8B35E9F1CE10
  1. 8
      README.md
  2. 3
      reCTBN/src/params.rs

@ -56,3 +56,11 @@ To check the **formatting**:
```sh ```sh
cargo fmt --all -- --check cargo fmt --all -- --check
``` ```
## Documentation
To generate the **documentation**:
```sh
cargo rustdoc --package reCTBN --open -- --default-theme=ayu
```

@ -72,7 +72,6 @@ pub enum Params {
DiscreteStatesContinousTime(DiscreteStatesContinousTimeParams), DiscreteStatesContinousTime(DiscreteStatesContinousTimeParams),
} }
/// DiscreteStatesContinousTime.
/// This represents the parameters of a classical discrete node for ctbn and it's composed by the /// This represents the parameters of a classical discrete node for ctbn and it's composed by the
/// following elements: /// following elements:
/// - `label` /// - `label`
@ -109,7 +108,7 @@ impl DiscreteStatesContinousTimeParams {
} }
/// Setter function for CIM. /// Setter function for CIM.
/// ///
/// This function check if the CIM is valid using the validate_params method: /// This function check if the CIM is valid using the validate_params method:
/// - **Valid CIM inserted**: it substitute the CIM in self.cim and return `Ok(())`. /// - **Valid CIM inserted**: it substitute the CIM in self.cim and return `Ok(())`.
/// - **Invalid CIM inserted**: it replace the self.cim value with None and it returns /// - **Invalid CIM inserted**: it replace the self.cim value with None and it returns

Loading…
Cancel
Save