The State of Inline Docs
We haven’t posted an update in several weeks, so thought we’d bring everyone up to speed on the Inline Docs project.
This project started July at WordCamp San Francisco as a 3.7 release action item. Work continues into the 3.8 release cycle, and we would like to have the hook documentation completed by the time 3.8 is released in December.
PHP Documentation Standards
The PHP Documentation Standard has been amended several times since it was first published in early September. The latest amendments include:
- Documenting Tips (language, tools for finding the version for
@since, code refactoring)
- Formatting Guidelines
- A change to the way duplicate hooks should be documented (
/** This action|filter is documented in path/to/file.php */)
If you are one of our contributors, please make sure you read the standards again to familiarize yourself with the changes.
WordCamp Contributor Days
We would like to thank WordCamp Toronto (10/6), WordCamp Europe (10/7), and WordCamp Sofia (10/27) for including Inline Docs as part of their respective Contributor Days. Approximately 35 files were documented, and several new contributors had their first patches committed to WordPress core as a result. Woot!
So far, 47 people have received props for submitting inline docs patches:
@admiralthrawn, @aeg0125, @a.hoereth, @andg, @aralbald, @bananastalktome, @ben.moody, @betzster, @bftrick, @dllh, @drewapicture, @dougwollison, @dustyf, @enej, @ericlewis, @Faison, @FrankKlein, @gayadesign, @gizburdt, @johnafish, @johnbillion, @jonlynch, @kpdesign, @l10n, @nacin, @naomicbush, @NikV, @ninio, @miyauchi, @morduak, @Nao, @natejacobs, @netweb, @nukaga, @nullvariable, @pauldewouters, @r3df, @rzen, @sboisvert, @SergeyBiryukov, @ShinichiN, @Siobhyb, @swissspidy, @tmtoy, @tomauger, @tw2113, @vinod dalvi
There are 10 other contributors with patches waiting to be reviewed and committed that will be added to this list. We want to thank everyone for their participation so far, and hope you continue contributing!
Progress To Date
According to the “master list“, there are 185 files containing hooks to be documented. The current status, as of today:
- Completed: 92 files (49.72%)
- In progress: 23 files
- Available to claim: 70 files
Weekly Office Hours
We continue to hold weekly office hours meetings on Wednesdays at 19:00 UTC in #wordpress-sfd.