Documentation Community Team Meeting (April 2024)¶
Date: 2024-04-02
Time: 19:00 UTC
This HackMD: https://hackmd.io/@encukou/pydocswg1
Discourse thread (for April)
Meeting reports (the latest one might be an unmerged PR)
Calendar event: (send your e-mail to Mariatta for an invitation)
How to participate:
Go to Google Meet and ask to be let in.
To edit notes, click the “pencil” or “split view” button on the HackMD document. You need to log in (e.g. with a GitHub account).
By participating in this meeting, you are agreeing to abide by and uphold the PSF Code of Conduct. Please take a second to read through it!
Roll call¶
(Name / @GitHubUsername [/ Discord, if different])
Petr Viktorin /
@encukouHugo van Kemenade /
hugovkDaniele
Carol /
@willingcNed /
@nedbatCAM /
@CAM-GerlachBradley
Ashley /
@AWhetter
Reports and celebrations¶
[Carol] Docs summit at PyCon US https://us.pycon.org/2024/events/hatchery/docs-summit/
[Hugo] Modernised font on macOS: python/python-docs-theme#176
[Hugo] I wrote up how to activate tabs in Sphinx docs based on the reader’s OS: https://dev.to/hugovk/sphinx-docs-how-to-activate-tabs-for-your-os-pd3
[Hugo] Python 3.11 is now only accepting security fixes, so very few docs PRs need backporting: https://devguide.python.org/versions/
Discussion¶
Changelog splitting/reduction¶
No use cases other than “grepping it all” found so far.
[CAM] WarningMessage is undocumented¶
https://discuss.python.org/t/warningmessage-is-undocumented/48877
Please read the thread and chime in!
Parameter annotations: int | float or int or float?¶
https://discuss.python.org/t/how-should-we-mark-up-multiple-types-in-a-type-field/48196
Next meeting¶
The docs team generally meets on the first Tuesday of every month around 19:00-ish UTC.
We have a recurring Google Calendar event for the meeting. Let Mariatta know your email address and she can invite you.