diff options
| author | Dimitri Staessens <dimitri@ouroboros.rocks> | 2026-07-26 13:49:26 +0200 |
|---|---|---|
| committer | Dimitri Staessens <dimitri@ouroboros.rocks> | 2026-07-26 14:50:26 +0200 |
| commit | 33f3c6fc4ca8810cee4c517594be725a26eec70c (patch) | |
| tree | c4b2f8c14357b1b4e979e01c3b516ddf254f3b98 /README.md | |
| parent | 3947452e391b1f1fc3933b28ce97d86e3b555d84 (diff) | |
| download | pyouroboros-33f3c6fc4ca8810cee4c517594be725a26eec70c.tar.gz pyouroboros-33f3c6fc4ca8810cee4c517594be725a26eec70c.zip | |
This is basically a clean up pass to make sure all docstrings are
aligned. The copyright banners are replaced by SPDX statements. Also
did a general clean up on the comments. Passes pylint. No structural
changes.
Signed-off-by: Dimitri Staessens <dimitri@ouroboros.rocks>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -314,7 +314,7 @@ from ouroboros.irm import ( For most use cases, the higher-level [`ouroboros.cli`](#cli-helpers) wrappers are easier to work with — they mirror the `irm` CLI tool and -take IPCP names rather than pids. +are keyed by IPCP name. ### IPCP Management @@ -534,7 +534,7 @@ See the module docstring for the full CLI-command ↔ Python mapping. ## Examples -See the [`examples/`](examples/) folder for runnable client/server +See the [`examples/`](examples/) directory for runnable client/server demos. ## Versioning @@ -545,8 +545,8 @@ pyOuroboros uses `setuptools_scm` to derive its version from git tags. | Scope | Rule | |---|---| -| ouroboros (C) ↔ pyouroboros / rumba | Shared `major.minor` — pyouroboros requires at least the same ouroboros `major.minor` | -| pyouroboros ↔ rumba ↔ ouroboros-integration | Strict lockstep `major.minor.patch` — always released together | +| ouroboros (C) ↔ pyouroboros / rumba | Shared `major.minor`, C side at least equal | +| pyouroboros ↔ rumba ↔ ouroboros-integration | Lockstep `major.minor.patch`, released together | ## License |
