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 3 restaurants
I walked 3.1km in 29m25s
I walked 4.4km in 45m01s
I walked 5.4km in 55m28s
Updated a restaurant; Confirmed a hotel
I walked 6.3km in 1h12m59s
Paraphrasing opening keynote speaker at ConFoo: "Should we go back to the waterfall method of writing massive specs upfront to feed to AI coding agents?"
I walked 1.6km in 17m29s
I walked 2.1km in 17m44s
Updated a pub
I walked 2.6km in 26m41s
Merged pull request #1065
Comparison whether class is userland or internal used the wrong macro
PHP 8.6: zend_enum.h now mixes code with declarations
PHP 8.6: Argument names are now stored as zend_strings
Updated a bench and a waste_basket
I walked 8.3km in 1h25m37s
Created a recycling
I walked 10.5km in 1h46m57s
An interesting journey in story form, showing how English changed over time.
https://www.deadlanguagesociety.com/p/how-far-back-in-time-understand-english
A much better writer than I is summing up perfectly why I have such disdain for Generative AI/LLMs.
https://jonn.substack.com/p/so-why-do-i-feel-so-angry-about-this
Created a waste_basket; Updated a waste_basket; Deleted a bench
Created a bench; Updated 7 benches and a gate; Deleted 2 benches and a gate
Created 10 benches and 2 waste_baskets; Updated an information
Shortlink
This article has a short URL available: https://drck.me/adv1322-afh