From 763a8370ebf4fbc513ac3ff6c032f877ac8fcad2 Mon Sep 17 00:00:00 2001
From: Luis Moreno <morenol@users.noreply.github.com>
Date: Sat, 5 Jun 2021 00:25:34 -0400
Subject: [PATCH] docs: fix documentation of naive bayes structs

---
 src/naive_bayes/bernoulli.rs   | 3 ++-
 src/naive_bayes/gaussian.rs    | 5 +++--
 src/naive_bayes/multinomial.rs | 2 +-
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/naive_bayes/bernoulli.rs b/src/naive_bayes/bernoulli.rs
index 69eb13c..95c4d36 100644
--- a/src/naive_bayes/bernoulli.rs
+++ b/src/naive_bayes/bernoulli.rs
@@ -249,7 +249,8 @@ impl<T: RealNumber> BernoulliNBDistribution<T> {
     }
 }
 
-/// BernoulliNB implements the categorical naive Bayes algorithm for categorically distributed data.
+/// BernoulliNB implements the naive Bayes algorithm for data that follows the Bernoulli
+/// distribution.
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Debug, PartialEq)]
 pub struct BernoulliNB<T: RealNumber, M: Matrix<T>> {
diff --git a/src/naive_bayes/gaussian.rs b/src/naive_bayes/gaussian.rs
index b84e65f..bd23919 100644
--- a/src/naive_bayes/gaussian.rs
+++ b/src/naive_bayes/gaussian.rs
@@ -33,7 +33,7 @@ use crate::naive_bayes::{BaseNaiveBayes, NBDistribution};
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
-/// Naive Bayes classifier for categorical features
+/// Naive Bayes classifier using Gaussian distribution
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Debug, PartialEq)]
 struct GaussianNBDistribution<T: RealNumber> {
@@ -179,7 +179,8 @@ impl<T: RealNumber> GaussianNBDistribution<T> {
     }
 }
 
-/// GaussianNB implements the categorical naive Bayes algorithm for categorically distributed data.
+/// GaussianNB implements the naive Bayes algorithm for data that follows the Gaussian
+/// distribution.
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Debug, PartialEq)]
 pub struct GaussianNB<T: RealNumber, M: Matrix<T>> {
diff --git a/src/naive_bayes/multinomial.rs b/src/naive_bayes/multinomial.rs
index 43a022a..f42b99e 100644
--- a/src/naive_bayes/multinomial.rs
+++ b/src/naive_bayes/multinomial.rs
@@ -212,7 +212,7 @@ impl<T: RealNumber> MultinomialNBDistribution<T> {
     }
 }
 
-/// MultinomialNB implements the categorical naive Bayes algorithm for categorically distributed data.
+/// MultinomialNB implements the naive Bayes algorithm for multinomially distributed data.
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Debug, PartialEq)]
 pub struct MultinomialNB<T: RealNumber, M: Matrix<T>> {