[wp-trac] [WordPress Trac] #51306: Add inline documentation for atomlib.php (was: Document missing in _p($msg) function)

[WordPress Trac]

#51306: Add inline documentation for atomlib.php
--------------------------+------------------------------
 Reporter:  ravivaddweb   |       Owner:  (none)
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Feeds         |     Version:  5.5
 Severity:  normal        |  Resolution:
 Keywords:                |     Focuses:  docs
--------------------------+------------------------------
Changes (by SergeyBiryukov):

 * keywords:  has-patch =>
 * component:  Comments => Feeds


Comment:

 Hi there, welcome to WordPress Trac! Thanks for the ticket.

 Similarly to `class-pclzip.php` in #49163, `atomlib.php` used to be
 treated as an external library and was previously excluded from any
 documentation or coding standard fixes. We only modify third-party
 libraries when it's needed to fix a bug, like in [37461], [38883], or
 [39591].

 That said, looking at the [https://core.trac.wordpress.org/log/trunk/src
 /wp-includes/atomlib.php?mode=follow_copy commit history], there were some
 string changes in the past, so I think it's safe to treat `atomlib.php` as
 "adopted" library rather than external. Related: #50498.

 If we were to improve the documentation though, I think it would be better
 to document all the functions in that file, rather than one at a time.

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