Review main Merged

90491[DOCS] Mark up BE template API examples as code

Mathias Brodala CR +2 V +2 Easy +42 −6 updated 08/27/25, 16:07

Commit message

Also reduce the "Example" intro to not scream and shorten it. Unless
there are multiple examples there is not much value in a title.
Especially not if it is just copy/paste.

Review

  • Code review CR +2 Done
    • Garvin Hicking +2
    • Oliver Klee +1
  • Verified V +2 Done
    • Garvin Hicking +2
    • Oliver Klee +1
    • core-ci +1 CI

Issues 1

Files 12

Review log 1518

  1. Mathias Brodala uploaded patch set 1 08/27/25, 08:22

  2. Oliver Klee voted on patch set 1 CR +1 V +1 08/27/25, 08:24

  3. Lina Wolf voted on patch set 1 CR +1 V +1 08/27/25, 08:26

  4. Oliver Klee commented on patch set 1 08/27/25, 08:27

    ShortcutButton.php:42

    Would adding the markup language (adding `php` after the three backticks) work here so any renderer can use language-specific syntax highlighting? According to https://stackoverflow.com/questions/11741302/how-do-i-put-blocks-of-php-code-into-a-phpdoc-docblock this should be the proper way to do this. However, I don't know the contexts in which our doc blocks will get rendered.
  5. core-ci voted on patch set 1 V +1 08/27/25, 08:30 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/83895

  6. Mathias Brodala commented on patch set 1 08/27/25, 08:30

    ShortcutButton.php:42 Reply

    I wouldn't mind unless someone objects. I'd assume the default code role to be "php" on api.typo3.org though.
  7. Lina Wolf commented on patch set 1 08/27/25, 08:32

    ShortcutButton.php:42 Reply

    It is possible but unnessesary as we assume PHP to be the default language It would be advisable to do this with other languages like JavaScript or TypoScript however.
  8. Garvin Hicking commented on patch set 1 08/27/25, 08:43

    I would prefer to label this as DOCS or TASK as it doesn't affect TYPO3 as code.
  9. Oli Bartsch commented on patch set 1 08/27/25, 08:46

    Reply

    Yes, no bugfix I think.
  10. Oliver Klee commented on patch set 1 08/27/25, 08:54

    ShortcutButton.php:42 Reply

    Acknowledged
  11. Mathias Brodala updated the commit message in patch set 2 CR +1 V +1 08/27/25, 09:37

  12. core-ci voted on patch set 2 V +1 08/27/25, 09:45 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/83898

  13. Garvin Hicking updated the commit message in patch set 3 V +1 08/27/25, 09:53

  14. Garvin Hicking commented on patch set 3 CR +1 V +1 08/27/25, 09:54

    Reply

    I think for the API docs we also would need 13.4 and 12.4 backports to render them properly on supported LTS versions, sorry 😅 - changed accordingly already.
  15. Oliver Klee voted on patch set 3 CR +1 V +1 08/27/25, 09:55

  16. core-ci voted on patch set 3 V +1 08/27/25, 10:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/83899

  17. Garvin Hicking voted on patch set 3 CR +2 V +2 08/27/25, 16:07

  18. Garvin Hicking merged patch set 4 08/27/25, 16:07