WordPress / WordPress/WordPress-Coding-Standards
Check for capital and full stop on @return description
Open
Nobody has claimed this yet.
Component: Docs
Status: Needs investigation
- Dominant language
- PHP
- Stars
- 2.8k
- Forks
- 521
- Avg merge
- 5d 20h
- Merged PRs (30d)
- 1
Description
I've not delved into it, but I was not getting any notifications about missing full stops on @return descriptions.
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
No file or test is named. Start by reproducing the missing notification for capitalisation and full stops in @return descriptions, then trace the PHP_CodeSniffer rule that handles return annotations. Done means violations are reported consistently for the described @return text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100