Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PHPCS Sniff: Align DocBlock comments #4

Open
roshniahuja opened this issue Feb 13, 2025 · 0 comments
Open

PHPCS Sniff: Align DocBlock comments #4

roshniahuja opened this issue Feb 13, 2025 · 0 comments

Comments

@roshniahuja
Copy link

roshniahuja commented Feb 13, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant