WordPress.org

Make WordPress Core

Opened 3 months ago

Last modified 3 months ago

#51306 new defect (bug)

Add inline documentation for atomlib.php

Reported by: ravivaddweb Owned by:
Milestone: Awaiting Review Priority: normal
Severity: normal Version: 5.5
Component: Feeds Keywords:
Focuses: docs Cc:

Description

Doc: Add $msg parameter entry for _p($msg) function

Attachments (5)

51306.patch (223 bytes) - added by ravivaddweb 3 months ago.
51306.2.patch (223 bytes) - added by ravivaddweb 3 months ago.
Added new patch file
51306.3.patch (361 bytes) - added by ravivaddweb 3 months ago.
Adding modifying patch
51306.4.patch (388 bytes) - added by ravivaddweb 3 months ago.
Add new patchfile
51306.5.patch (394 bytes) - added by ravivaddweb 3 months ago.
Upload correction of the patch file

Download all attachments as: .zip

Change History (8)

@ravivaddweb
3 months ago

#1 @ravivaddweb
3 months ago

  • Keywords has-patch added; needs-patch removed

I have added patch of this issue

@ravivaddweb
3 months ago

Added new patch file

@ravivaddweb
3 months ago

Adding modifying patch

@ravivaddweb
3 months ago

Add new patchfile

@ravivaddweb
3 months ago

Upload correction of the patch file

#2 @ravivaddweb
3 months ago

Keywords has-patch added

Last edited 3 months ago by ravivaddweb (previous) (diff)

#3 @SergeyBiryukov
3 months ago

  • Component changed from Comments to Feeds
  • Keywords has-patch removed
  • Summary changed from Document missing in _p($msg) function to Add inline documentation for atomlib.php

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 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.

Note: See TracTickets for help on using tickets.