From 33f3c6fc4ca8810cee4c517594be725a26eec70c Mon Sep 17 00:00:00 2001 From: Dimitri Staessens Date: Sun, 26 Jul 2026 13:49:26 +0200 Subject: pyouroboros: Use consistent format docstrings 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 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5871d8c..1a55fc3 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3