[wp-trac] [WordPress Trac] #45486: Docs: Correct the inline documentation for rest_sanitize_value_from_schema()
WordPress Trac
noreply at wordpress.org
Sat May 16 21:38:20 UTC 2020
#45486: Docs: Correct the inline documentation for
rest_sanitize_value_from_schema()
--------------------------------------+-----------------------------
Reporter: birgire | Owner: SergeyBiryukov
Type: task (blessed) | Status: reviewing
Priority: normal | Milestone: Future Release
Component: REST API | Version: 4.7
Severity: normal | Resolution:
Keywords: good-first-bug has-patch | Focuses: docs
--------------------------------------+-----------------------------
Comment (by TimothyBlynJacobs):
I think this makes more sense as `mixed`. As @Jean-David points out, the
input is returned as a fall through, so mixed is the most accurate.
Additionally, the docblock is meant to provide value, and I don't think
documenting every possible return type separately makes the documentation
anymore valuable to the reader.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/45486#comment:12>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list