[wp-trac] [WordPress Trac] #28467: Improved inline docs for set_transient & set_site_transient in options.php

[WordPress Trac]

#28467: Improved inline docs for set_transient & set_site_transient in options.php
------------------------------------------------------+--------------------
 Reporter:  edwin-at-studiojoyo.com                   |       Owner:
     Type:  enhancement                               |      Status:  new
 Priority:  normal                                    |   Milestone:  4.0
Component:  Options, Meta APIs                        |     Version:  trunk
 Severity:  normal                                    |  Resolution:
 Keywords:  has-patch dev-feedback reporter-feedback  |     Focuses:  docs
------------------------------------------------------+--------------------

Comment (by edwin-at-studiojoyo.com):

 The maximal length is a requirement, as the transient name will fail if
 maximal length is exceeded. Thus, "should" must be changed to "must":

 ''MUST: This word, or the terms "REQUIRED" or "SHALL", mean that the
 definition is an absolute requirement of the specification. (see
 http://www.ietf.org/rfc/rfc2119.txt).''

 Will attach newly corrected patch.

 As an addition, the Codex
 (http://codex.wordpress.org/Function_Reference/set_transient and
 http://codex.wordpress.org/Function_Reference/set_site_transient) must
 also use the word "must", in stead of "should".

--
Ticket URL: <https://core.trac.wordpress.org/ticket/28467#comment:4>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform