Skip to content

Commit 46ded4e

Browse files
authored
Merge pull request #28 from HEnquist/next201
Clean up old names in documentation, mention need to connect
2 parents 2a41384 + c1cb658 commit 46ded4e

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

camilladsp/camilladsp.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
_reason_from_reply,
2828
)
2929

30-
VERSION = "2.0.0"
30+
VERSION = "2.0.1"
3131

3232

3333
class CamillaError(ValueError):
@@ -878,6 +878,10 @@ def __init__(self, host: str, port: int):
878878
"""
879879
Create a new CamillaClient.
880880
881+
The newly created CamillaClient does not
882+
automatically connect to the CamillaDSP process.
883+
Call `connect()` to initiate the connection.
884+
881885
Args:
882886
host (str): Hostname where CamillaDSP runs.
883887
port (int): Port number of the CamillaDSP websocket server.

docs/errors.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ The custom exception [CamillaError][camilladsp.camilladsp.CamillaError] is raise
55

66
Different exceptions are raised in different situations. Consider the following example:
77
```python
8-
from camilladsp import CamillaConnection, CamillaError
9-
cdsp = CamillaConnection("127.0.0.1", 1234)
8+
from camilladsp import CamillaClient, CamillaError
9+
cdsp = CamillaClient("127.0.0.1", 1234)
1010

1111
myconfig = # get a config from somewhere
1212
try:
@@ -19,9 +19,10 @@ except CamillaError as e:
1919
except IOError as e:
2020
print("Websocket is not connected:", e)
2121
```
22-
- `ConnectionRefusedError` means that CamillaDSP isn't responding on the given host and port.
22+
- `ConnectionRefusedError` means that CamillaDSP isn't responding on the given host and port.
2323
- `CamillaError` means that the command was sent and CamillaDSP replied with an error.
24-
- `IOError` can mean a few things, but the most likely is that the websocket connection was lost. This happens if the CamillaDSP process exits or is restarted.
24+
- `IOError` can mean a few things, but the most likely is that the websocket connection was lost.
25+
This happens if the CamillaDSP process exits or is restarted.
2526

2627
## CamillaError
2728
::: camilladsp.camilladsp.CamillaError

0 commit comments

Comments
 (0)