From 18b27f9413a4c1b7a20c64a29aafe21b79c561d7 Mon Sep 17 00:00:00 2001 From: E33605 Date: Tue, 5 Nov 2024 13:11:19 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20fix=20attribute=20parameters?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/fuzzy.md | 4 ++++ nlpurify/fuzzy/logical.py | 10 +++++----- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/fuzzy.md b/docs/fuzzy.md index 7720308..000304c 100644 --- a/docs/fuzzy.md +++ b/docs/fuzzy.md @@ -2,6 +2,10 @@
+```{eval-rst} +.. automodule:: nlpurify.fuzzy +``` + ## Fuzzy Scoring Wrapper ```{eval-rst} diff --git a/nlpurify/fuzzy/logical.py b/nlpurify/fuzzy/logical.py index 57c96fd..0abd0dd 100644 --- a/nlpurify/fuzzy/logical.py +++ b/nlpurify/fuzzy/logical.py @@ -20,15 +20,15 @@ class LogicalFuzzy: also reduces repeated function call involving loops and other conditional statements. - :attr string: str + :type string: str :param string: The original string against which the reference values are to be checked and validated. - :attr references: list + :type references: list :param references: A list of n-references against which fuzzy score is determined. The score is also a n-length array. - :attr method: str + :type method: str :param method: Amy of the supported method :func:`fuzzywuzzy.fuzz` module, defaults to "partial_ratio" method. @@ -85,11 +85,11 @@ def evaluate(self, thresh : int, logic : str, operator : str = ">="): and is evaluated using the :func:`eval()` to determine the final result and provide the score. - :attr logic: str + :type logic: str :param logic: The logical operator which is either :attr:`all` i.e., and condition and :attr:`any` which is or condition. - :attr operator: str + :type operator: str :param operator: The deterministic operator which can be used to efficiently control both the side of the curve for fuzzy scoring.