From 2153f46758b367f9803bc520fcf0d9ee7be2abbb Mon Sep 17 00:00:00 2001 From: meliurwen Date: Mon, 17 Oct 2022 12:03:14 +0200 Subject: [PATCH] Fixed small lint problem and added a paragraph to the README --- README.md | 8 ++++++++ reCTBN/src/params.rs | 3 +-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f928955..6a60dff 100644 --- a/README.md +++ b/README.md @@ -56,3 +56,11 @@ To check the **formatting**: ```sh cargo fmt --all -- --check ``` + +## Documentation + +To generate the **documentation**: + +```sh +cargo rustdoc --package reCTBN --open -- --default-theme=ayu +``` diff --git a/reCTBN/src/params.rs b/reCTBN/src/params.rs index d7bf8f8..65db06c 100644 --- a/reCTBN/src/params.rs +++ b/reCTBN/src/params.rs @@ -72,7 +72,6 @@ pub enum Params { DiscreteStatesContinousTime(DiscreteStatesContinousTimeParams), } -/// DiscreteStatesContinousTime. /// This represents the parameters of a classical discrete node for ctbn and it's composed by the /// following elements: /// - `label` @@ -109,7 +108,7 @@ impl DiscreteStatesContinousTimeParams { } /// Setter function for CIM. - /// + /// /// 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(())`. /// - **Invalid CIM inserted**: it replace the self.cim value with None and it returns