#20063 closed defect (bug) (fixed)
Incorrect PHPDoc for get_current_screen
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Priority: | normal | Milestone: | 3.4 |
| Component: | Inline Docs | Version: | 3.3.1 |
| Severity: | minor | Keywords: | |
| Cc: |
Description
The PHPDoc documentation for get_current_screen doesn't properly define the type of object which is returned. It should be:-
* @return object WP_Screen
Patch attached.
Obviously this doesn't make any difference to the running of the code, but will make life easier for anyone with IDE's which parse PHPDoc comments.
Attachments (1)
Change History (7)
comment:2
in reply to:
↑ 1
markauk
— 16 months ago
Yes! I was being unnecessarily frugal with words...
Patch updated.
comment:3
nacin
— 16 months ago
The point was that you can omit 'object' and simply use the actual object WP_Screen as the type designator.
comment:4
nacin
— 16 months ago
- Owner set to nacin
- Resolution set to fixed
- Status changed from new to closed
In [19942]:
comment:5
SergeyBiryukov
— 16 months ago
- Milestone changed from Awaiting Review to 3.4
comment:6
SergeyBiryukov
— 16 months ago
- Component changed from General to Inline Docs
Note: See
TracTickets for help on using
tickets.
Since we can name the specific class it could be: