File tree Expand file tree Collapse file tree 7 files changed +16
-13
lines changed Expand file tree Collapse file tree 7 files changed +16
-13
lines changed Original file line number Diff line number Diff line change @@ -24,10 +24,15 @@ See `CONTRIBUTING.md`.
2424
2525## Usage
2626to stay consistent with the language from the original paper, we recommend
27- importing this package as ` ring ` :
27+ naming your chordnet attribute ` ring ` :
2828``` python
29- from chordnet import Node as ring
29+ from chordnet import ChordNet
30+
31+ ring = new ChordNet(... )
32+ ring.create()
33+ # or ring.join(...)
34+ # ...
35+ ring.leave()
3036```
3137This fits with the concept of "joining" an existing ring network, or creating a
32- new one, (` ring.join(...) ` , ` ring.create() ` .
33- Examples follow this practice.
38+ new one. Examples follow this practice.
Original file line number Diff line number Diff line change @@ -119,13 +119,11 @@ convention = "google"
119119python_version = " 3.10"
120120warn_return_any = true
121121warn_unused_configs = true
122+ mypy_path = " src"
122123files = [" src" , " tests" , " scripts" ]
123124exclude = [
124125 ' (^|.*/)__pycache__/' , # matches __pycache__ at any depth
125126 ' (^|.*/).ruff_cache/' ,
126127 ' (^|.*/).mypy_cache/' ,
128+ ' (^|.*/)dist/' ,
127129]
128-
129- [[tool .mypy .overrides ]]
130- module = [" bpython" ]
131- ignore_missing_imports = true
Original file line number Diff line number Diff line change 33
44import IPython
55
6- from chordnet import Node as ChordNode
6+ from chordnet . _node import _Node as ChordNode
77
88
99def main () -> None :
Original file line number Diff line number Diff line change 33
44import IPython
55
6- from chordnet import Node as ChordNode
6+ from chordnet . _node import _Node as ChordNode
77
88
99def main () -> None :
Original file line number Diff line number Diff line change 44import IPython
55from step import step #type: ignore
66
7- from chordnet import Node as ChordNode
7+ from chordnet . _node import _Node as ChordNode
88
99
1010def main () -> None :
Original file line number Diff line number Diff line change 44import IPython
55from step import step #type: ignore
66
7- from chordnet import Node as ChordNode
7+ from chordnet . _node import _Node as ChordNode
88
99
1010def main () -> None :
Original file line number Diff line number Diff line change 11"""step.py: helper for manual scripts."""
22
3- from chordnet import Node as ChordNode
3+ from chordnet . _node import _Node as ChordNode
44
55
66def step (node : ChordNode ) -> None :
You can’t perform that action at this time.
0 commit comments