Review main Merged

76596[DOCS] Mark codesnippets in Language API

Lina Wolf CR +2 V +2 Easy +17 −9 updated 11/17/22, 22:22

Commit message

Review

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

Issues 1

Files 1

Review log 1012

  1. Lina Wolf uploaded patch set 1 11/14/22, 13:13

  2. core-ci voted on patch set 1 V +1 11/14/22, 13:20 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/33702

  3. Christian Kuhn commented on patch set 1 CR -1 11/14/22, 13:42

    not convinced we should add this docs dependency to our codebase.
  4. Lina Wolf commented on patch set 1 11/14/22, 15:46

    Undetected code snippets cause warnings in rendering this page currently: https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Localization/LocalizationApi/LanguageService.html I used the most wide-spread format for marking code blocks, currently we have 56 code blocks in php doc comments that are marked with 3 backticks. On the fly I also generally reviewed the other comments and applied some language fixes that do not change meaning but improve readability.
  5. Lina Wolf uploaded patch set 2 11/17/22, 22:10

  6. Lina Wolf uploaded patch set 3 11/17/22, 22:13

  7. Christian Kuhn commented on patch set 2 V +1 CR +1 11/17/22, 22:14

    ok, here is the deal with Lina: We do actively mark-up bigger code example blocks in methods and class comments, but we do not mark-up single variables.
  8. Stefan Bürk voted on patch set 3 V +1 CR +1 11/17/22, 22:14

  9. Christian Kuhn voted on patch set 3 V +1 CR +1 11/17/22, 22:14

  10. core-ci voted on patch set 3 V +1 11/17/22, 22:21 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/33893

  11. Lina Wolf voted on patch set 3 V +2 CR +2 11/17/22, 22:21

  12. Lina Wolf merged patch set 4 11/17/22, 22:22