WordPress / WordPress/WordPress-Coding-Standards
Docs: Check type for long form of integer and boolean
Open
Nobody has claimed this yet.
Component: Docs
Type: Enhancement
- Dominant language
- PHP
- Stars
- 2.8k
- Forks
- 521
- Avg merge
- 5d 20h
- Merged PRs (30d)
- 1
Description
The short form of int and bool is preferred for @param and @return, but currently:
/**
* ...
*
* @param integer $object_id Object ID.
* @param boolean $single Whether returns as single or array.
*/
is not reported.
There may be something in PHPCS that covers this already that just needs adding in.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by checking the existing PHP_CodeSniffer rules for @param and @return type handling, including any rule that already recognizes int and bool. The work is done when long-form integer and boolean types are reported while the preferred short forms remain accepted, with coverage for the shown annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100