Merged
Conversation
…ce CSS styles, and improve code readability
- Added CSVField and RichTableField enums to define available fields for CSV and Rich Table reporters. - Updated CSVOptions and RichTableOptions to utilize the new field enums for better type safety and clarity. - Modified CSVReporter and RichTableReporter to dynamically generate headers and rows based on the specified fields. - Enhanced error handling in options classes to validate field types and values. - Improved documentation for options parameters and their expected types.
- Expanded the explanation of the benchmark function to clarify the use of parameters as keyword arguments. - Added detailed examples for `kwarg_variations` and `variation_cols`, illustrating how to define them and the resulting combinations in benchmark tests. - Clarified the purpose of the `use_field_for_n` parameter and its optional nature, including its default behavior. - Improved formatting and readability in both HTML and reStructuredText documentation.
…update related documentation Added validation of kwargs_variations against benchmarked function signature
- Changed parameter name from 'bench' to '_bench' in my_benchmark_action function across multiple files for consistency. - Updated documentation to reflect the new parameter name and clarify action function signature requirements. - Adjusted return type references in documentation to point to the correct Results class. - Enhanced error handling in the Case class to manage exceptions during type hint resolution. - Minor formatting improvements in tutorial and example sections for better readability.
- Updated the tutorial on parameterized benchmarks to include a new section on multi-dimensional parameters. - Added a minimal example of a multi-dimensional parameterized benchmark in both HTML and reStructuredText formats. - Changed the description in the minimal parameterized benchmark example to reflect its parameterized nature. - Introduced a new Python script for multi-dimensional parameterized benchmarking with detailed output expectations. - Included expected output for the new benchmark example to aid users in understanding the results.
JerilynFranz
added a commit
that referenced
this pull request
Nov 30, 2025
Merge pull request #14 from JerilynFranz/Documentation-Updates
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces the 0.5.0-alpha-0 release of SimpleBench, focusing on improved support for parameterized benchmarks, enhanced customization of report outputs, and expanded documentation and examples. It also updates documentation structure and minor development environment settings.
Key highlights:
Most important changes:
Feature enhancements:
CSVReporterandRichTableReporterto allow customization of output columns using options.Documentation and examples:
minimal_parameterized_benchmark.pyandmultidimensional_parameterized_benchmark.py. [1] [2]Documentation structure and versioning:
Development environment:
.vscode/settings.jsonto set the Python testing working directory, ensuring consistent test discovery. [1] [2]Internal code and docs:
simplebench.caseto includeget_type_hintsfor improved type checking.These changes collectively improve usability, documentation, and reporting flexibility for SimpleBench users.