From ca833c966a1c1c2d8623abbd6d9811bcb7942de7 Mon Sep 17 00:00:00 2001 From: Patrick Jentsch Date: Tue, 7 Apr 2020 16:36:27 +0200 Subject: [PATCH] fixes and doc --- app/corpora/cqi/api/client.py | 3 ++- app/corpora/cqi/client.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/app/corpora/cqi/api/client.py b/app/corpora/cqi/api/client.py index 9c257203..bc62e65f 100644 --- a/app/corpora/cqi/api/client.py +++ b/app/corpora/cqi/api/client.py @@ -20,10 +20,11 @@ class APIClient: >>> client.ctrl_bye() {'code': 259, 'msg': 'CQI_STATUS_BYE_OK'} - Args: + Attributes: host (str): URL to the CQP server. For example, ``cqpserver.localhost`` or ``127.0.0.1``. port (int): Port the CQP server listens on. Default: ``4877`` + socket (socket.socket): Socket for communicating with a CQP server. """ def __init__(self, host, port=4877): diff --git a/app/corpora/cqi/client.py b/app/corpora/cqi/client.py index 1f965e15..0fba29eb 100644 --- a/app/corpora/cqi/client.py +++ b/app/corpora/cqi/client.py @@ -15,8 +15,9 @@ class CQiClient: {'code': 260, 'msg': 'CQI_STATUS_PING_OK'} >>> client.disconnect() {'code': 259, 'msg': 'CQI_STATUS_BYE_OK'} + Attributes: - api (APIClient): A client pointing to the specified to the CQP server. + api (APIClient): An API client pointing to the specified CQP server. """ def __init__(self, host, port=4877):