Skip to content

Commit 3f4e18c

Browse files
committed
Missing docs
Signed-off-by: Raul Sevilla <[email protected]>
1 parent 2f58c98 commit 3f4e18c

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

fmatch/matcher.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,15 @@
1818

1919

2020
class Matcher:
21-
"""Matcher"""
21+
"""
22+
A class used to match or interact with an Elasticsearch index for performance scale testing.
23+
24+
Attributes:
25+
index (str): Name of the Elasticsearch index to interact with.
26+
level (int): Logging level (e.g., logging.INFO).
27+
ES_URL (str): Elasticsearch endpoint, can be specified by the environment variable ES_SERVER
28+
verify_certs (bool): Whether to verify SSL certificates when connecting to Elasticsearch.
29+
"""
2230

2331
def __init__(
2432
self,

0 commit comments

Comments
 (0)