#3659 closed task (blessed) (fixed)
Missing inline documentation tags and formatting
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Milestone: | 2.7 | Priority: | normal |
| Severity: | normal | Version: | |
| Component: | General | Keywords: | has-patch commit |
| Cc: |
Description
Several core files contain inline documentation that does not fully align with WordPress PHP Documentation Standards.
Issues identified:
- Some functions are missing
@returntags. - Full stops (periods) are missing at the end of some function summaries and parameter descriptions.
- Some
@paramtags are missing descriptions.
Affected files:
src/bbpress.phpsrc/includes/admin/classes/class-bbp-admin.phpsrc/includes/forums/functions.phpsrc/includes/replies/functions.phpsrc/includes/topics/functions.phpsrc/includes/users/signups.php
Change History (5)
This ticket was mentioned in PR #37 on bbpress/bbPress by @huzaifaalmesbah.
5 weeks ago
#1
- Keywords has-patch added
#2
@
5 weeks ago
- Keywords commit added
- Milestone changed from Awaiting Review to 2.7
- Owner set to johnjamesjacoby
- Status changed from new to assigned
- Type changed from defect (bug) to task (blessed)
Fixed missing full stops (periods) in function summaries and descriptions.
This is a rule that I've stubbornly avoided working on (because fragments don't deserve full-stops) but I suppose it's time. 😅
#3
@
5 weeks ago
I checked the updated files, and everything looks good now.
The missing tags and formatting issues you mentioned earlier are all fixed. Nice work!
@johnjamesjacoby commented on PR #37:
10 days ago
#5
Note: See
TracTickets for help on using
tickets.
This PR improves the inline documentation coverage and formatting across several core files to align with WordPress PHP Documentation Standards.
## Changes
@returntags.@paramdescriptions.## Files Modified
src/includes/admin/classes/class-bbp-admin.phpsrc/includes/forums/functions.phpsrc/includes/replies/functions.phpsrc/includes/topics/functions.phpsrc/includes/users/signups.phpSee #3659