docs(patch): Add example on how parameterization is done

[hassila]

Description

Added another sample for how to run parametrised benchmarks

Fixes https://github.com/ordo-one/package-benchmark/issues/224

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Minimal checklist:

• [x] I have performed a self-review of my own code
• [x] I have added DocC code-level documentation for any public interfaces exported by the package
• [ ] I have added unit and/or integration tests that prove my fix is effective or that my feature works

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (3bb4e7d) 66.84% compared to head (42fa488) 66.77%.

Additional details and impacted files

[](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/225?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) ```diff @@ Coverage Diff @@ ## main #225 +/- ## ========================================== - Coverage 66.84% 66.77% -0.07% ========================================== Files 33 33 Lines 4303 4294 -9 ========================================== - Hits 2876 2867 -9 Misses 1427 1427 ``` | [Files](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/225?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) | Coverage Δ | | |---|---|---| | [Tests/BenchmarkTests/BenchmarkResultTests.swift](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/225?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one#diff-VGVzdHMvQmVuY2htYXJrVGVzdHMvQmVuY2htYXJrUmVzdWx0VGVzdHMuc3dpZnQ=) | `100.00% <ø> (ø)` | | | [Files](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/225?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) | Coverage Δ | | |---|---|---| | [Tests/BenchmarkTests/BenchmarkResultTests.swift](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/225?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one#diff-VGVzdHMvQmVuY2htYXJrVGVzdHMvQmVuY2htYXJrUmVzdWx0VGVzdHMuc3dpZnQ=) | `100.00% <ø> (ø)` | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/225?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/225?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). Last update [3bb4e7d...42fa488](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/225?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one).

[github-actions[bot]]

Pull request had an unknown failure Pull request benchmark comparison [ubuntu-latest] with 'main' run at 2024-01-12T15:43:05+00:00