Skip to content

Commit bf05e0d

Browse files
committed
fix docs
1 parent 5f77d02 commit bf05e0d

File tree

2 files changed

+3
-13
lines changed

2 files changed

+3
-13
lines changed

README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,3 @@ ring.leave()
3434
```
3535
This fits with the concept of "joining" an existing ring network, or creating a
3636
new one. Examples follow this practice.
37-
38-
## Development
39-
See `CONTRIBUTING.md` [(here)](https://github.com/jacklowrie/chordnet?tab=contributing-ov-file).
40-
41-
## Security
42-
If you discover a security issue, **please do not open a public issue**.
43-
See the [security policy](https://github.com/jacklowrie/chordnet/security/policy)
44-
for reporting instructions.

src/chordnet/chordnet.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ def __init__(self,
1717
Args:
1818
ip: IP address for the node.
1919
port: Port number to listen on.
20-
daemon: whether to run the daemon.
21-
interval: daemon interval.
22-
debug: whether to print node state after every daemon run.
20+
interval: daemon interval (how often to 'sync' with the network)
2321
"""
2422
self._node = _Node(ip, port, interval=interval)
2523

@@ -37,8 +35,8 @@ def join(self, known_ip: str, known_port: int) -> None:
3735
An existing chordnet can be joined through any node already on the ring.
3836
3937
Args:
40-
known_ip (str): IP address of an existing node in the Chord ring.
41-
known_port (int): Port number of the existing node.
38+
known_ip: IP address of an existing node in the Chord ring.
39+
known_port: Port number of the existing node.
4240
"""
4341
self._node.join(known_ip, known_port)
4442

0 commit comments

Comments
 (0)