API page:
https://api.drupal.org/api/drupal/core%21core.api.php/function/hook_conf...

The example code is not correctly formatted -- it uses < code > tags instead of @code

CommentFileSizeAuthor
#3 badly-formatted-sample-code-2975368-3.patch724 bytesmsankhala

Comments

msankhala created an issue. See original summary.

msankhala’s picture

msankhala commented
Title: badly formatted sample code in core.api.php » badly formatted sample code in core.api.php for hook_config_import_steps_alter
msankhala’s picture

msankhala commented
StatusFileSize
new badly-formatted-sample-code-2975368-3.patch724 bytes

Here is the patch.

msankhala’s picture

msankhala commented
Status: Active » Needs review
alexrayu’s picture

alexrayu commented

Subscribe. That's the correct code markup as per Drupal comment standards. https://www.drupal.org/docs/develop/coding-standards/api-documentation-a...

msankhala’s picture

msankhala commented

@alexrayu Can you please review this patch?

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented
Status: Needs review » Reviewed & tested by the community

This is a good improvement, I don't see any other places in .api.php files of the wrong style.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed de1dd0c415 to 8.6.x and 1c73e27be9 to 8.5.x. Thanks!

  • alexpott committed de1dd0c on 8.6.x 
    Issue #2975368 by msankhala: badly formatted sample code in core.api.php...

  • alexpott committed 1c73e27 on 8.5.x 
    Issue #2975368 by msankhala: badly formatted sample code in core.api.php...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.