Skip to content

Commit 92518ab

Browse files
committed
docs: add a docstring
1 parent 244d5f6 commit 92518ab

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

NLPPlus/__init__.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,19 @@ def output(self) -> Optional[Any]:
6161

6262

6363
class Engine:
64+
"""NLP++ Engine for a given working folder.
65+
66+
Args:
67+
68+
working_folder(optional, PathLike): Working folder for this
69+
instance. If None, a temporary directory will be created
70+
and initialized with the default analyzers. Otherwise,
71+
this must contain an `analyzers` and a `data` folder,
72+
unless `initialize` is `True`.
73+
verbose(optional, bool): Be more verbose.
74+
initialize(optional, bool): Initialize `working_folder` with
75+
the default analyzers.
76+
"""
6477
def __init__(
6578
self,
6679
working_folder: Optional[PathLike] = None,

0 commit comments

Comments
 (0)