Review main Merged

76442[DOCS] Mark code snippets as code in PHP doc comments

Lina Wolf CR +2 V +2 Normal +58 −0 updated 11/05/22, 12:06

Commit message

Non-marked code-snippets notoriously cause rendering
errors in the documentation where ever we render
doc-comments. Therefore all code snippets should be
marked as such. This also adds some space around
code snippets and makes them easier to read for the
nacked eye. Some extensive code-snippets might better
be moved directly into the documentation but this wa
not part of this change.

Throughout the Core we have different methods of
marking code: Markdown style as applied here and
html-style with `<pre>` or `<code>` tags. We can
interpret both so I did not attempt to unify this
situation.

Review

  • Code review CR +2 Done
    • Lina Wolf +2
    • Chris Müller +1
    • Oliver Klee +1
    • Benni Mack +1
  • Verified V +2 Done
    • Lina Wolf +2
    • Chris Müller +1
    • Oliver Klee +1
    • Benni Mack +1
    • core-ci +1 CI

Issues 1

Files 19

Review log 1013

  1. Lina Wolf uploaded patch set 1 11/04/22, 18:39

  2. Lina Wolf updated the commit message in patch set 2 11/04/22, 18:42

  3. core-ci voted on patch set 1 V +1 11/04/22, 18:47 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/33136

  4. core-ci voted on patch set 2 V +1 11/04/22, 18:51 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/33137

  5. Oliver Klee updated the commit message in patch set 3 11/04/22, 19:11

  6. core-ci voted on patch set 3 V +1 11/04/22, 19:18 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/33138

  7. Chris Müller commented on patch set 3 11/04/22, 19:39

    AbstractMetaTagManager.php:61

    Please also adjust the indentation when you are on it. Als mind the last line (missing space before "]").
  8. Lina Wolf commented on patch set 3 11/04/22, 19:55

    AbstractMetaTagManager.php:61 Reply

    changing or checking the code snippets is not part of this Change. However due to the marking they are easy to find now. They can be corrected in another Change
  9. Chris Müller commented on patch set 3 V +1 CR +1 11/04/22, 20:12

    AbstractMetaTagManager.php:61 Reply

    Ack
  10. Oliver Klee voted on patch set 3 V +1 CR +1 11/05/22, 09:05

  11. Benni Mack voted on patch set 3 V +1 CR +1 11/05/22, 11:58

  12. Lina Wolf voted on patch set 3 V +2 CR +2 11/05/22, 12:06

  13. Lina Wolf merged patch set 4 11/05/22, 12:06