summaryrefslogtreecommitdiffstats
path: root/python
diff options
context:
space:
mode:
authortmartins <thigm85@gmail.com>2020-09-01 22:00:25 +0200
committertmartins <thigm85@gmail.com>2020-09-01 22:00:25 +0200
commitaf28ae7ca325f4bac47b36ccaab83605e80156e0 (patch)
tree41ea382bd1eeb6321322337e9f8ced24f3628f03 /python
parent5b5e81ada288d8523983c1bfe1448f5843dd67a9 (diff)
fix Vespa docstring
Diffstat (limited to 'python')
-rw-r--r--python/vespa/vespa/application.py16
1 files changed, 8 insertions, 8 deletions
diff --git a/python/vespa/vespa/application.py b/python/vespa/vespa/application.py
index 6ccf5e8d854..c11e56d2125 100644
--- a/python/vespa/vespa/application.py
+++ b/python/vespa/vespa/application.py
@@ -20,14 +20,14 @@ class Vespa(object):
"""
Establish a connection with a Vespa application.
- :param url: URL
- :param port: Port
- :param deployment_message: Message returned by Vespa engine after deployment.
- :param cert: Path to certificate and key file
-
- >>> Vespa(url = "https://cord19.vespa.ai")
- >>> Vespa(url = "http://localhost", port = 8080)
- >>> Vespa(url = "https://api.vespa-external.aws.oath.cloud", port = 4443, cert = "/path/to/cert-and-key.pem")
+ :param url: Vespa instance URL.
+ :param port: Vespa instance port.
+ :param deployment_message: Message returned by Vespa engine after deployment. Used internally by deploy methods.
+ :param cert: Path to certificate and key file.
+
+ >>> Vespa(url = "https://cord19.vespa.ai")
+ >>> Vespa(url = "http://localhost", port = 8080)
+ >>> Vespa(url = "https://api.vespa-external.aws.oath.cloud", port = 4443, cert = "/path/to/cert-and-key.pem")
"""
self.url = url