Contributing Advent 22: Documenting changes
Probably one of the easier things to contribute to an Open Source project when you don't really have much experience, or simply don't know the language well enough—or in Xdebug's case, PHP's internals, is documentation. In the past a few people, such as Wim Godden and Jarl Ostensen have already contributed some documentation fixes.
In the last few months I have added support for serialized "collect params", XDEBUG_TRACE_NAKED_FILENAME (issue #971), XDEBUG_STACK_NO_DESC (issue #1003), and the ability to halt on warning/notice (issue #1004). And neither of those are documented now. So this article is about adding the documentation of these new features.
Xdebug's documentation is part of the website, which has a project on GitHub. However, it's not in any standard format. Functions are documented in single files, such as here for xdebug_start_trace(), and in a rather rudimentary format that some other tools I have use to generate stuff as well. So a bit tricky, and this is something I'd like to improve, however it's rather easy to add to.
Configuration settings are all in one file and stored as an nested PHP array. I have now added a new supported value (5) for xdebug.collect_params which needs documenting too, which is as simple as adding a new line to it. Of course, I have also documented the changes to xdebug_print_function_stack() and the addition of xdebug.halt_level.
Xdebug's documentation is (I think pretty good), but if you have sugggestions I would be more than happy to get suggestions, or of course even better would be a pull request.
Life Line
Updated a waste_basket
Created 11 benches, 2 life_rings, and 3 other objects; Updated 8 benches and a waste_basket; Deleted a bench and a log; Confirmed a cafe
I walked 7.8km in 1h52m27s
Tomorrow we have elections in the UK!
Lots of local authorities, all London Councils, the Welsh Senedd, and the Scottish Parliament.
Don't forget to vote if you have the right.
I get to vote for myself again 😎.
Benches, and corrections for the QE II Gardens
Addresses on College Road
Created 2 main entrances and an entrance; Updated an entrance, a residential building, and a house building
Created an apartments building and a main entrance
I walked 9.5km in 2h21m10s
Created a waste_basket
I walked 6.6km in 1h13m23s
On my walk from Aylesbury to Princes Risborough I spotted a few new bird species. I didn't get all the best photos though!
A Common Buzzard, a Yellow Wagtail, a Greater White throat, and a Green Woodpecker.
#photography #Birds #BirdPhotogaphy #BirdsOfMastodon #nature #Buckinghamshire
Updated an alcohol shop
I walked 9.4km in 1h58m25s
Updated 2 benches
Created a bench; Updated a bench
I hiked 19.0km in 4h35m50s
I hiked 19.0km in 4h35m50s
I walked 6.8km in 1h15m36s
Updated an estate_agent office
I walked 4.1km in 55m33s
I walked 1.1km in 10m05s
My First Lapwing!
I went to the London Wetland Centre yesterday, for a day out in nature.
While hiding in a hide, this chap and a friend showed up starting to forage for grubs.
#BirdPhotography #BirdsOfMastodon #Photography #Birds #London #Nature
Created a waste_basket; Updated a cafe and a restaurant; Confirmed an estate_agent office
I walked 6.6km in 1h8m53s
Shortlink
This article has a short URL available: https://drck.me/adv1322-afh