Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: format & fix php errors #548

Merged
merged 7 commits into from
Mar 22, 2024
Merged

docs: format & fix php errors #548

merged 7 commits into from
Mar 22, 2024

Conversation

DavidBadura
Copy link
Member

No description provided.

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 21, 2024 •
edited
Loading

Hello 👋

here is the most recent benchmark result: 

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

+---------------------------+-----------------+-----------------+-----------------+------------+
|                           | time (kde mode)                   | memory                       |
+---------------------------+-----------------+-----------------+-----------------+------------+
| subject                   | Tag: <current>  | Tag: base       | Tag: <current>  | Tag: base  |
+---------------------------+-----------------+-----------------+-----------------+------------+
| benchHandle10000Events () | 3.220s (±0.00%) | 3.226s (±0.00%) | 39.098mb        | 39.085mb   |
+---------------------------+-----------------+-----------------+-----------------+------------+

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

+-------------------------+--------------------+--------------------+-----------------+------------+
|                         | time (kde mode)                         | memory                       |
+-------------------------+--------------------+--------------------+-----------------+------------+
| subject                 | Tag: <current>     | Tag: base          | Tag: <current>  | Tag: base  |
+-------------------------+--------------------+--------------------+-----------------+------------+
| benchLoad10000Events () | 5.519ms (±0.00%)   | 5.509ms (±0.00%)   | 42.564mb        | 42.550mb   |
| benchSave10000Events () | 627.553ms (±0.00%) | 645.377ms (±0.00%) | 42.841mb        | 42.828mb   |
+-------------------------+--------------------+--------------------+-----------------+------------+

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

+----------------------------------------+--------------------+--------------------+-----------------+------------+
|                                        | time (kde mode)                         | memory                       |
+----------------------------------------+--------------------+--------------------+-----------------+------------+
| subject                                | Tag: <current>     | Tag: base          | Tag: <current>  | Tag: base  |
+----------------------------------------+--------------------+--------------------+-----------------+------------+
| benchLoad10000Events ()                | 165.754ms (±0.00%) | 164.890ms (±0.00%) | 38.699mb        | 38.685mb   |
| benchSave1Event ()                     | 866.100μs (±0.00%) | 872.000μs (±0.00%) | 38.699mb        | 38.685mb   |
| benchSave10000Events ()                | 468.812ms (±0.00%) | 475.572ms (±0.00%) | 38.965mb        | 38.952mb   |
| benchSave10000Aggregates ()            | 8.803s (±0.00%)    | 8.711s (±0.00%)    | 38.699mb        | 38.685mb   |
| benchSave10000AggregatesTransaction () | 7.390s (±0.00%)    | 7.374s (±0.00%)    | 38.699mb        | 38.685mb   |
+----------------------------------------+--------------------+--------------------+-----------------+------------+

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

+----------------------------------------+--------------------+--------------------+-----------------+------------+
|                                        | time (kde mode)                         | memory                       |
+----------------------------------------+--------------------+--------------------+-----------------+------------+
| subject                                | Tag: <current>     | Tag: base          | Tag: <current>  | Tag: base  |
+----------------------------------------+--------------------+--------------------+-----------------+------------+
| benchLoad10000EventsMissingSnapshot () | 164.189ms (±0.00%) | 163.580ms (±0.00%) | 38.696mb        | 38.682mb   |
| benchLoad10000Events ()                | 504.800μs (±0.00%) | 509.600μs (±0.00%) | 38.696mb        | 38.682mb   |
+----------------------------------------+--------------------+--------------------+-----------------+------------+

This comment gets update everytime a new commit comes in!

@DavidBadura DavidBadura changed the title check docs code format docs Mar 21, 2024
@DavidBadura DavidBadura changed the title code format docs docs: format & fix php errors Mar 21, 2024
@DavidBadura DavidBadura marked this pull request as ready for review March 21, 2024 14:29
@DavidBadura DavidBadura added the documentation Improvements or additions to documentation label Mar 21, 2024
@DavidBadura DavidBadura added this to the 3.0.0 milestone Mar 21, 2024
DanielBadura
DanielBadura approved these changes Mar 22, 2024
View reviewed changes
.github/workflows/docs-check.yml Outdated Show resolved Hide resolved
.github/workflows/docs-check.yml
run: "php -l docs_php/*.php"

- name: "docs code style"
run: "vendor/bin/phpcbf docs_php --exclude=SlevomatCodingStandard.TypeHints.DeclareStrictTypes"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i like this solution perse: i wonder how the checks from othe SA tools will change due to the "missing" declare(strict_types=1);. Should be minor i think, but still WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if it behaves differently, but we can't change anything about it, otherwise we would always be formatting because we always remove that. But we already have 500 psalm errors that need to be fixed/ignored :D

composer.json
@@ -38,6 +38,7 @@
"cspray/phinal": "^2.0.0",
"doctrine/orm": "^2.18.0|^3.0.0",
"infection/infection": "^0.27.0",
"league/commonmark": "^2.4",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe move to tools?

Copy link
Member Author

@DavidBadura DavidBadura Mar 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could try it out and see if it works. But I don't want to do that here anymore. I had to start over 3 times because I had an error in the script. I want to save the status for now :D

composer.json
@@ -48,7 +49,8 @@
"roave/infection-static-analysis-plugin": "^1.34.0",
"symfony/messenger": "^5.4.31|^6.4.0|^7.0.1",
"symfony/var-dumper": "^5.4.29|^6.4.0|^7.0.0",
"vimeo/psalm": "^5.17.0"
"vimeo/psalm": "^5.17.0",
"wnx/commonmark-markdown-renderer": "^1.4"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe move to tools?

@DavidBadura DavidBadura merged commit a796a60 into 3.0.x Mar 22, 2024
33 of 35 checks passed
@DavidBadura DavidBadura deleted the check-docs branch March 22, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DanielBadura DanielBadura DanielBadura approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
3.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@DavidBadura @DanielBadura