[wp-trac] [WordPress Trac] #28806: More complete and consistent @deprecated inline docs/tags
WordPress Trac
noreply at wordpress.org
Thu Aug 20 20:54:40 UTC 2015
#28806: More complete and consistent @deprecated inline docs/tags
--------------------------+-----------------------------
Reporter: Alphawolf | Owner:
Type: defect (bug) | Status: new
Priority: low | Milestone: Future Release
Component: General | Version:
Severity: normal | Resolution:
Keywords: has-patch | Focuses: docs
--------------------------+-----------------------------
Old description:
> Hey folks, I noticed some `@deprecated` inline docs were inconsistent
> and/or incorrect for various functions so I went and did the following
> things:
>
> - Changed the `@deprecated` inline tag(s) to follow the new
> [https://make.wordpress.org/core/handbook/inline-documentation-standards
> /php-documentation-standards/#1-2-deprecated-functions inline docs
> standard] written last year
> - Added version information if missing but known
> - Added fourth parameter (what to use instead) to
> `_deprecated_function()` if missing but known
> - More consistent wording throughout the @deprecated inline docs
>
> Patch attached.
>
> ps. First patch (AFAIR). :)
New description:
Hey folks, I noticed some `@deprecated` inline docs were inconsistent
and/or incorrect for various functions so I went and did the following
things:
- Changed the `@deprecated` inline tag(s) to follow the new
[https://make.wordpress.org/core/handbook/best-practices/inline-
documentation-standards/php/#1-2-deprecated-functions inline docs
standard] written last year
- Added version information if missing but known
- Added fourth parameter (what to use instead) to `_deprecated_function()`
if missing but known
- More consistent wording throughout the @deprecated inline docs
Patch attached.
ps. First patch (AFAIR). :)
--
Comment (by DrewAPicture):
Th
--
Ticket URL: <https://core.trac.wordpress.org/ticket/28806#comment:15>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list