[wp-trac] [WordPress Trac] #63746: Suggestion for Standardizing PHPDoc Comments for do_action Parameters in WordPress Core

[WordPress Trac]

#63746: Suggestion for Standardizing PHPDoc Comments for do_action Parameters in
WordPress Core
-------------------------------------------------+-------------------------
 Reporter:  viralsampat                          |       Owner:  (none)
     Type:  enhancement                          |      Status:  new
 Priority:  normal                               |   Milestone:  Awaiting
                                                 |  Review
Component:  General                              |     Version:
 Severity:  normal                               |  Resolution:
 Keywords:  has-patch dev-feedback needs-        |     Focuses:  docs
  testing 2nd-opinion                            |
-------------------------------------------------+-------------------------

Comment (by justlevine):

 My understanding is that this _is standardized, and the "standard" is
 intentionally to document them once in the "primary" location and then to
 reference where that primary documentation is if we need to reapply the
 hook somewhere else.

 I'm assuming the reason is to maintain a single source of truth.

 This shouldn't currently have any affect on static analysis, as our
 codebase doesn't use generics and most likely won't until PHPStan is
 merged.

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