From a39aad1505da214d5c330294498479d816e6d835 Mon Sep 17 00:00:00 2001 From: Alex Lubbock Date: Sun, 26 Apr 2026 13:22:38 +0100 Subject: [PATCH] docs: remove stale cli_compatible from extending guide and note removal in CHANGELOG --- CHANGELOG.md | 6 ++++++ docs/user-guide/extending.md | 1 - 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a566de5..ad1634c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -51,6 +51,12 @@ All notable changes to microbench are documented here. ### Documentation +- **`cli_compatible` class attribute removed from built-in mixins**: this + attribute was never read at runtime — CLI availability is governed solely + by the `MIXIN_REGISTRY` in `cli/registry.py`. The extending guide example + has been updated to drop it; custom mixins that set it can safely remove + it without any behavioural change. + - Fix documentation on writing custom mixins to note that they must be added to the registry if they are to be detected by the CLI. diff --git a/docs/user-guide/extending.md b/docs/user-guide/extending.md index 72c2697..7b6dad9 100644 --- a/docs/user-guide/extending.md +++ b/docs/user-guide/extending.md @@ -54,7 +54,6 @@ from microbench import CLIArg class MBOutputDir: """Record the output directory for this run.""" - cli_compatible = True cli_args = [ CLIArg( flags=['--output-dir'],