cleanup docs

[DavidBadura]

No description provided.

[github-actions]

Hello 👋

here is the most recent benchmark result:

SplitStreamBench
================

+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                         | time (kde mode)                                     | memory                                     |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                 | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad10000Events () | 4.804ms (±0.00%)   | 4.916ms (±0.00%)   | -2.28%    | 35.650mb        | 36.167mb   | -1.43%      |
| benchSave10000Events () | 310.588ms (±0.00%) | 320.605ms (±0.00%) | -3.12%    | 35.652mb        | 36.170mb   | -1.43%      |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SimpleSetupStreamStoreBench
===========================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 1.046ms (±0.00%)   | 1.051ms (±0.00%)   | -0.45%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchLoad10000Events ()                | 63.430ms (±0.00%)  | 64.037ms (±0.00%)  | -0.95%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchSave1Event ()                     | 1.384ms (±0.00%)   | 1.463ms (±0.00%)   | -5.44%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchSave10000Events ()                | 263.047ms (±0.00%) | 273.770ms (±0.00%) | -3.92%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchSave10000Aggregates ()            | 7.902s (±0.00%)    | 8.025s (±0.00%)    | -1.52%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 5.270s (±0.00%)    | 5.283s (±0.00%)    | -0.23%    | 35.206mb        | 35.206mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SimpleSetupBench
================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 1.080ms (±0.00%)   | 1.074ms (±0.00%)   | +0.51%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchLoad10000Events ()                | 58.373ms (±0.00%)  | 58.265ms (±0.00%)  | +0.19%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchSave1Event ()                     | 1.232ms (±0.00%)   | 1.251ms (±0.00%)   | -1.51%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchSave10000Events ()                | 206.254ms (±0.00%) | 206.602ms (±0.00%) | -0.17%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchSave10000Aggregates ()            | 7.782s (±0.00%)    | 7.794s (±0.00%)    | -0.16%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 5.187s (±0.00%)    | 5.209s (±0.00%)    | -0.42%    | 34.979mb        | 34.979mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SubscriptionEngineBatchBench
============================

+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
|                           | time (kde mode)                                   | memory                                     |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| subject                   | Tag: <current>    | Tag: base         | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| benchHandle10000Events () | 78.797ms (±0.00%) | 80.833ms (±0.00%) | -2.52%    | 35.544mb        | 35.544mb   | 0.00%       |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+

NoopSubscriptionEngineBench
===========================

+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
|                           | time (kde mode)                                   | memory                                     |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| subject                   | Tag: <current>    | Tag: base         | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| benchHandle10000Events () | 75.635ms (±0.00%) | 78.016ms (±0.00%) | -3.05%    | 47.560mb        | 47.560mb   | 0.00%       |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+

SubscriptionEngineBench
=======================

+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
|                           | time (kde mode)                               | memory                                     |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
| subject                   | Tag: <current>  | Tag: base       | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
| benchHandle10000Events () | 3.164s (±0.00%) | 3.178s (±0.00%) | -0.44%    | 47.560mb        | 47.560mb   | 0.00%       |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+

CommandToQueryBench
===================

+----------------+------------------+------------------+-----------+-----------------+------------+-------------+
|                | time (kde mode)                                 | memory                                     |
+----------------+------------------+------------------+-----------+-----------------+------------+-------------+
| subject        | Tag: <current>   | Tag: base        | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------+------------------+------------------+-----------+-----------------+------------+-------------+
| benchCreate () | 2.693ms (±0.00%) | 2.713ms (±0.00%) | -0.74%    | 4.976mb         | 4.976mb    | 0.00%       |
| benchUpdate () | 3.674ms (±0.00%) | 3.834ms (±0.00%) | -4.18%    | 4.981mb         | 4.981mb    | 0.00%       |
| benchBoth ()   | 6.348ms (±0.00%) | 6.488ms (±0.00%) | -2.15%    | 5.024mb         | 5.024mb    | 0.00%       |
+----------------+------------------+------------------+-----------+-----------------+------------+-------------+

PersonalDataBench
=================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 1.279ms (±0.00%)   | 1.340ms (±0.00%)   | -4.53%    | 35.585mb        | 35.585mb   | 0.00%       |
| benchLoad10000Events ()                | 93.363ms (±0.00%)  | 93.756ms (±0.00%)  | -0.42%    | 35.585mb        | 35.585mb   | 0.00%       |
| benchSave1Event ()                     | 1.886ms (±0.00%)   | 1.771ms (±0.00%)   | +6.52%    | 35.585mb        | 35.585mb   | 0.00%       |
| benchSave10000Events ()                | 229.583ms (±0.00%) | 232.909ms (±0.00%) | -1.43%    | 35.586mb        | 35.586mb   | 0.00%       |
| benchSave10000Aggregates ()            | 12.117s (±0.00%)   | 12.200s (±0.00%)   | -0.68%    | 35.585mb        | 35.585mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 9.404s (±0.00%)    | 9.415s (±0.00%)    | -0.12%    | 36.044mb        | 36.044mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SnapshotsBench
==============

+----------------------------------------+-------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                    | memory                                     |
+----------------------------------------+-------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>    | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+-------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad10000EventsMissingSnapshot () | 59.050ms (±0.00%) | 59.135ms (±0.00%)  | -0.14%    | 35.049mb        | 35.049mb   | 0.00%       |
| benchLoad10000Events ()                | 1.026ms (±0.00%)  | 997.900μs (±0.00%) | +2.82%    | 35.049mb        | 35.049mb   | 0.00%       |
+----------------------------------------+-------------------+--------------------+-----------+-----------------+------------+-------------+

This comment gets update everytime a new commit comes in!