Opened 9 years ago
Closed 9 years ago
#28203 closed defect (bug) (fixed)
Improve inline docs description for WP_Error::__construct()
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 4.0 | Priority: | normal |
Severity: | normal | Version: | 2.7 |
Component: | General | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
The docblock description of WP_Error::__construct()
is confusing.
* If code parameter is empty then nothing will be done. It is possible to * add multiple messages to the same code, but with other methods in the * class. * * All parameters are optional, but if the code parameter is set, then the * data parameter is optional.
Introduced in [8900].
Attachments (2)
Change History (6)
#1
@
9 years ago
- Keywords needs-patch added
- Milestone changed from Awaiting Review to 4.0
I agree the original description is confusing. It would be nice to make the second part less ambiguous. "other methods" is pretty vague:
It is possible to add multiple messages to the same code by using other methods in the class.
Can we be more specific here?
#2
@
9 years ago
28203.2.patch removes the ambiguity, and improves the summary for the add()
method as well.
#3
@
9 years ago
- Keywords has-patch added; needs-patch removed
28203.2.patch is much better, thanks.
Note: See
TracTickets for help on using
tickets.
First pass, could probably be much improved