Opened 10 months ago
Last modified 10 months ago
#63315 new defect (bug)
Docs: Improve the `prepare()` function inline docs
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Milestone: | Awaiting Review | Priority: | normal |
| Severity: | normal | Version: | |
| Component: | Query | Keywords: | has-patch close |
| Focuses: | docs | Cc: |
Description
I've reviewed the wpdb::prepare() function and made the following improvements to its inline documentation:
- Removed the duplicate mention of the
$argsparameter. - Cleaned up the description by removing an unnecessary hyphen from the
$queryparameter.
Attachments (1)
Note: See
TracTickets for help on using
tickets.
Hi there, thanks for the patch!
The current description seems correct as is:
$argsand...$argsparameters aim to differentiate between calling the method with an array of arguments to substitute into the query's placeholders and passing a variable number of individual arguments. The former part of the description should not be removed.sprintf()-likewording is correct, the hyphen is used to join the two words together as an adjective.