[wp-trac] [WordPress Trac] #41593: Document every function parameter that expects slashed data
WordPress Trac
noreply at wordpress.org
Wed Aug 9 15:09:37 UTC 2017
#41593: Document every function parameter that expects slashed data
----------------------------+----------------------------
Reporter: johnbillion | Owner:
Type: task (blessed) | Status: new
Priority: normal | Milestone: Future Release
Component: General | Version:
Severity: normal | Keywords: needs-patch
Focuses: docs |
----------------------------+----------------------------
There are several inline comments in core which state `//
expected_slashed`, indicating that a variable's value is expected to
contain slashed data.
This information should be documented in the corresponding function's
parameter documentation, and any "parent" functions that call those
functions.
It's more than likely that there are other places in core which expect
slashed data which are not documented with `// expected_slashed`. These
need to be identified (comments welcome).
--
Ticket URL: <https://core.trac.wordpress.org/ticket/41593>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list