|
| 1 | +# Documentation Community Team Meeting (December 2023) |
| 2 | + |
| 3 | +- **Date:** 2023-12-05 |
| 4 | +- **Time:** [20:00 UTC](https://arewemeetingyet.com/UTC/2023-12-05/20:00/Docs%20Meeting) |
| 5 | +- **This HackMD:** https://hackmd.io/@encukou/pydocswg1 |
| 6 | +- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-december-5-2023/40119) (for December) |
| 7 | +- [**Meeting reports**](https://docs-community.readthedocs.io/en/latest/monthly-meeting/) (the latest one might be an [**unmerged PR**](https://github.com/python/docs-community/pulls)) |
| 8 | +- **Calendar event:** (send your e-mail to Mariatta for an invitation) |
| 9 | +- **How to participate:** |
| 10 | + - Go to [Google Meet](https://meet.google.com/dii-qrzf-wkw) and ask to be let in. |
| 11 | + - To edit notes, click the “pencil” or “split view” button on the [HackMD document](https://hackmd.io/@encukou/pydocswg1). You need to log in (e.g. with a GitHub account). |
| 12 | + |
| 13 | +By participating in this meeting, you are agreeing to abide by and uphold the [PSF Code of Conduct](https://www.python.org/psf/codeofconduct/). |
| 14 | +Please take a second to read through it! |
| 15 | + |
| 16 | +## Roll call |
| 17 | + |
| 18 | +(Name / `@GitHubUsername` *[/ Discord, if different]*) |
| 19 | +- Petr Viktorin / `@encukou` |
| 20 | +- Daniele Procida / `@danieleprocida` |
| 21 | +- Hugo van Kemenade / `@hugovk` |
| 22 | +- Jim DeLaHunt / `@JDLH` |
| 23 | +- Ryan Duve / `@ryan-duve` |
| 24 | +- Ned Batchelder / `@nedbat` |
| 25 | +- Bradley / `@shenanigansd` |
| 26 | +- Ezio Melotti / `@ezio-melotti` |
| 27 | +- CAM Gerlach / `@CAM-Gerlach` |
| 28 | +- Usman Akinyemi / `@Unique-Usman` |
| 29 | + |
| 30 | +## Discussion |
| 31 | + |
| 32 | +- [Ryan] Standard library documentation reference and adding types to it in a structured way. For example, `collections.Counter.most_common` could be written as `most_common(n: int) -> list[tuple[Any, int]]`. |
| 33 | + - [Petr] ... or `list[tuple[KeyType, int]]`? |
| 34 | + - This has been discussed. There was opposition to adding the types to the stdlib code itself. |
| 35 | + - [Jim] I sometimes wish for more normative, less chatty module documentation: |
| 36 | + - e.g. [*heapq* module](https://docs.python.org/3/library/heapq.html) |
| 37 | + - e.g. old issue 29428 [*Doctest documentation unclear about multi-line fixtures*](https://bugs.python.org/issue29428) |
| 38 | + |
| 39 | +- [Petr] Use emoji to illustrate good and bad example commit messages |
| 40 | + - https://devguide.python.org/getting-started/git-boot-camp/#accepting-and-merging-a-pull-request |
| 41 | + - [python/devguide#1235](https://github.com/python/devguide/pull/1235) |
| 42 | + - Should we do this for PEPs? See [python/docs-community#22](https://github.com/python/docs-community/issues/22) |
| 43 | + - [Hugo] See also [python/peps#3567](https://github.com/python/peps/pull/3567) for green/red sidebars for good/bad example code in PEPs |
| 44 | + - [Jim] don't forget accessibility constraints when coming up with the style guide. For example, some readers are red/green colorblind. ✅/❌ are good in that they are legible even without color. |
| 45 | + |
| 46 | +- [Ryan] Thoughts about completing TOML->JSON [conversion table](https://docs.python.org/3/library/tomllib.html#conversion-table) and [the TOML spec](https://toml.io/en/v1.0.0#spec) |
| 47 | + |
| 48 | + |
| 49 | +## Reports and celebrations |
| 50 | + |
| 51 | +- PEP 732 ("The Python Documentation Editorial Board") has been submitted to the steering council [python/steering-council#220](https://github.com/python/steering-council/issues/220) |
| 52 | + |
| 53 | +- [Jim] FYI, Unicode Standard is changing form of authoritative standard documents from PDF to HTML, with corresponding change to document production tooling. If this is interesting I can provide more information. I am in the working group which is working on the new tooling. |
| 54 | + |
| 55 | +## Follow-ups from previous meeting(s) |
| 56 | + |
| 57 | +- [Petr] [Railroad diagrams](https://discuss.python.org/t/36709/20) |
| 58 | + - Streams have kind of been on other topics too |
| 59 | + |
| 60 | +- [Ege/Hugo/CAM] Analytics (Plausible) - CAM sent an e-mail (around late October), no reply yet |
| 61 | + - CAM sent multiple follow-ups |
| 62 | + - Hugo sent a follow-up two weeks ago |
| 63 | + - Discussion on core dev Discord that is supportive |
| 64 | + - Still no reply... :( |
| 65 | + |
| 66 | +## Next meeting |
| 67 | + |
| 68 | +The docs team generally meets on the first Tuesday of every month around 20:00-ish UTC. |
| 69 | + |
| 70 | +- [Jim] The first Tuesday of next month is 2 January. Will we be ready for this meeting on the day after New Year's Day? Answer: Basically yes; those who are ready will show up, others won't. |
| 71 | + |
| 72 | +We have a recurring Google Calendar event for the meeting. |
| 73 | +Let Mariatta know your email address and she can invite you. |
0 commit comments