Skip to content

PHPCS Sniff: Align DocBlock comments #4

@roshniahuja

Description

@roshniahuja

Issue : PHPCS Sniff: Align DocBlock Comments

Issue Description:
Some DocBlock comments in our repository are not properly aligned, which leads to PHPCS Sniff warnings. Example:

/**
 * @param mixed[] $raw_departures       Raw departures data from Softrip to update with.
 * @param string  $softrip_package_code Softrip package code.
 * @param int[]   $specific_departure_post_ids   Specific Departure post IDs to update. Default is empty.
 */

As seen above, the spacing of parameters is inconsistent. PHPCBF does not automatically fix this, and it needs to be manually formatted.

Expected Fix:
Align all @param, @return, and other DocBlock tags correctly.
Ensure proper indentation following our coding standards.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions