Skip to content

Commit

Permalink
📝 fix attribute parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
ZenithClown committed Nov 5, 2024
1 parent 22b8c6a commit 18b27f9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/fuzzy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

<div align = "justify">

```{eval-rst}
.. automodule:: nlpurify.fuzzy
```

## Fuzzy Scoring Wrapper

```{eval-rst}
Expand Down
10 changes: 5 additions & 5 deletions nlpurify/fuzzy/logical.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 18b27f9

Please sign in to comment.