Review main Merged

75833[DOCS] Improve doc comments for ModifyEditFormUserAccessEvent

Chris Müller CR +2 V +2 Easy +26 −0 updated 09/26/22, 14:54

Commit message

Method descriptions are added from the changelog here:
https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Feature-98304-PSR-14EventForModifyingEditFormUserAccess.html
to the source code. This also eases usage for coders who use the code
as documentation.

Review

  • Code review CR +2 Done
    • Stefan Bürk +2
    • Christian Kuhn +1
  • Verified V +2 Done
    • Stefan Bürk +2
    • Christian Kuhn +1
    • core-ci +1 CI

Issues 2

Files 1

Review log 1012

  1. Chris Müller uploaded patch set 1 09/21/22, 17:34

  2. core-ci voted on patch set 1 V +1 09/21/22, 17:42 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31391

  3. Oliver Klee commented on patch set 1 09/21/22, 17:42

    Very nice!

    ModifyEditFormUserAccessEvent.php:81

  4. Oliver Klee commented on patch set 1 09/21/22, 17:42

    ModifyEditFormUserAccessEvent.php:81 Reply

    $this->command then also needs this annotation.
  5. Chris Müller commented on patch set 1 09/22/22, 16:49

    ModifyEditFormUserAccessEvent.php:81 Reply

    I like this, but then PhpStorm complaints: "Argument type does not match the declared". May it be better to use "@phpstan-return" and "@phpstan-param" instead?
  6. Oliver Klee commented on patch set 1 09/22/22, 17:25

    ModifyEditFormUserAccessEvent.php:81 Reply

    That's a missing PhpStorm feature. The current strategy in the core is use type annotations that PhpStorm supports, but if we have a benefit from using notation that only works in PHPStan (and usually also Psalm), but not PhpStorm, we use that as well (because in the end PHPStan is what is run in the CI pipeline, not PhpStorm). And we're trying to avoid double type annotations (i.e., @param and @phpstan-param at the same time). There should only be one source of truth.
  7. Chris Müller uploaded patch set 2 09/23/22, 16:08

  8. Chris Müller commented on patch set 2 09/23/22, 16:08

    ModifyEditFormUserAccessEvent.php:81 Reply

    Ack
  9. core-ci voted on patch set 2 V +1 09/23/22, 16:16 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31488

  10. Christian Kuhn voted on patch set 2 V +1 CR +1 09/26/22, 14:51

  11. Stefan Bürk voted on patch set 2 V +2 CR +2 09/26/22, 14:53

  12. Stefan Bürk merged patch set 3 09/26/22, 14:54