Review main Merged

79163[TASK] Add comments for methods in ModifyVersionDifferencesEvent

Chris Müller CR +2 V +2 Easy +24 −0 updated 06/05/23, 06:20

Commit message

The method comments are useful for a developer using an IDE.
Additionally, as the docblocks are used for rendering the
event's API automatically for the docs, the documentation is
also improved.

Review

  • Code review CR +2 Done
    • Benni Mack +2
    • Oliver Klee +1
    • Sybille Peters +1
  • Verified V +2 Done
    • Benni Mack +2
    • Oliver Klee +1
    • Sybille Peters +1
    • core-ci +1 CI

Issues 2

Files 1

Review log 1519

  1. Chris Müller uploaded patch set 1 06/02/23, 18:26

  2. core-ci voted on patch set 1 V +1 06/02/23, 18:34 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/42169

  3. Oliver Klee commented on patch set 1 06/02/23, 18:37

    ModifyVersionDifferencesEvent.php:43

  4. Chris Müller commented on patch set 1 06/02/23, 18:51

    ModifyVersionDifferencesEvent.php:43 Reply

    Thought also about it. But: The list of fields is necessary anyway to describe the purpose of the keys. And the according class properties (which are returned by the methods) are already described by array shapes.
  5. Oliver Klee commented on patch set 1 06/02/23, 20:09

    ModifyVersionDifferencesEvent.php:43 Reply

    The I propose we still add an `@return` annotation with the array shapes. This will allow PHPStan to help devs who write code that calls this method.
  6. Chris Müller uploaded patch set 2 V +1 06/03/23, 05:28

  7. Chris Müller commented on patch set 2 06/03/23, 05:29

    ModifyVersionDifferencesEvent.php:43 Reply

    Ack
  8. core-ci voted on patch set 2 V -1 06/03/23, 05:40 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/42177

  9. Sybille Peters commented on patch set 2 06/03/23, 05:50

    ModifyVersionDifferencesEvent.php:65

    should be @return, I guess.
  10. Chris Müller uploaded patch set 3 V -1 06/03/23, 06:06

  11. Chris Müller uploaded patch set 4 06/03/23, 06:07

  12. Chris Müller commented on patch set 4 06/03/23, 06:07

    ModifyVersionDifferencesEvent.php:65 Reply

    Done
  13. core-ci voted on patch set 4 V +1 06/03/23, 06:15 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/42179

  14. core-ci voted on patch set 3 V +1 06/03/23, 06:24 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/42178

  15. Oliver Klee voted on patch set 4 V +1 CR +1 06/03/23, 07:24

  16. Sybille Peters voted on patch set 4 CR +1 06/03/23, 08:20

  17. Sybille Peters voted on patch set 4 V +1 06/04/23, 07:38

  18. Benni Mack voted on patch set 4 V +2 CR +2 06/05/23, 06:20

  19. Benni Mack merged patch set 5 06/05/23, 06:20