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
Little Owl owlet
This lovely owlet was quite easy to find in a London Park, with some help as they camouflage so well!
I saw its sibling too.
#BirdPhotography #BirdsOfFediverse #Photography #Nature #London #BirdsOfMastodon
I went to a park (Bushy Park) to look for some owls.
I found Owls (Little and Tawny), but also a Green Woodpecker and two Kingfishers.
Snaps from my camera screen, and real photos will follow, but not of the Kingfishers as they were too far away and the photos are blurry.
#london #BirdPhotogaphy #BirdsOfMastodon #Birds #photography #BirdsOfFediverse #BushyPark
I hiked 13.8km in 4h44m12s
Created a chocolate shop and a restaurant; Updated 6 restaurants and an address; Confirmed 5 restaurants, a community_centre, and 3 other objects
Created a restaurant, a fast_food, and 2 other objects; Deleted a restaurant
I walked 8.5km in 1h31m45s
Created 2 buildings and a hairdresser shop; Updated a restaurant and an estate_agent office; Confirmed a cafe
I walked 2.2km in 38m09s
Merged pull request #1096
Bump actions/checkout from 6 to 7
Merged pull request #1095
Improve Tiverton Green mapping
Created 2 gates
I walked 7.1km in 1h23m15s
I walked 1.0km in 9m24s
Realign streets. They now have much less wide corners into each other.
Updated a fast_food
I walked 9.1km in 1h35m41s
I hiked 4.7km in 3h24m10s
I walked 6.7km in 1h12m03s
I walked 7.7km in 1h47m24s
Updated a pub
Updated a pub
Created a bar; Updated a bar; Confirmed a restaurant and a bar
Shortlink
This article has a short URL available: https://drck.me/adv1322-afh