Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 0 additions & 1 deletion docs/user-guide/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'],
Expand Down
Loading