Opened 5 years ago
Last modified 3 months ago
#51306 new defect (bug)
Add inline documentation for atomlib.php
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Milestone: | Awaiting Review | Priority: | normal |
| Severity: | normal | Version: | 5.5 |
| Component: | Feeds | Keywords: | has-patch |
| Focuses: | docs | Cc: |
Description
Doc: Add $msg parameter entry for _p($msg) function
Attachments (5)
Change History (10)
#3
@
5 years 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.
This ticket was mentioned in PR #9763 on WordPress/wordpress-develop by @kush123.
3 months ago
#5
- Keywords has-patch added; needs-patch removed
Trac ticket: core.trac.wordpress.org/ticket/51306
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.
I have added patch of this issue