Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add December 2024 meeting notes #142

Merged
merged 1 commit into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions docs/monthly-meeting/2024-12.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Documentation Community Team Meeting (December 2024)

- **Date:** 2024-12-03
- **Time:** [20:00 UTC](https://arewemeetingyet.com/UTC/2024-11-05/20:00/Docs20Meeting)
- **This HackMD:** <https://hackmd.io/@encukou/pydocswg1>
- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-3rd-december-2024/72547/1)
(for December)
- [**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))
- **Calendar event:** (send your e-mail to Mariatta for an invitation)
- **How to participate:**
- We are using [Discord](https://discord.gg/RxKXyPYV?event=1303462925834522666) this
time
- 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).

By participating in this meeting, you are agreeing to abide by and uphold the
[PSF Code of Conduct](https://www.python.org/psf/codeofconduct/). Please take a second
to read through it!

## Roll call

(Name / `@GitHubUsername` _[/ Discord, if different]_)

- Petr Viktorin / `@encukou`
- Daniele
- Erlend / `@erlend-aasland`
- Trey
- Bartosz/bswck
- Hugo van Kemenade / `@hugovk`
- Ned / `@nedbat`
- Stan
- Ryan Duve / `ryan-duve`
- Blaise Pabon / `controlpl4n3`

## Discussion

- [Erlend]: Undocumented `calendar` APIs; what to do? (recently brought up by Pieter
Eendebak.)
[According to Serhiy](https://github.com/python/cpython/pull/108192#discussion_r1299892823),
several APIs are deliberately undocumented:

> But first than documenting these particular method or two, we should decide whether
> they should be documented at all.
>
> See past issues with the `calendar` module. There may be requests for undocumented
> methods, and some of them may even be rejected already. I think this has already
> been discussed.

I could not find previous discussions nor issues regarding this. IMO, we should either
document public API, or at least add an explanatory comment in the source code that
some APIs are deliberately undocumented. See also:

- [gh-126164](https://github.com/python/cpython/issues/126164)
- [gh-108202](https://github.com/python/cpython/issues/108202)

Discussion:

- [Petr] backwards compat ([PEP 387](https://peps.python.org/pep-0387/)) says things
without underscore are supported, even if not documented
- [Petr] a possibility is also to deprecate the APIs, or document them as deprecated
- [Erlend] list from Adam of undocumented APIs:
[python/cpython#108202 (comment)](https://github.com/python/cpython/issues/108202#issuecomment-1686798068)
- there was a short discussion that it was not immediately obvious if these APIs were
meant to be public or not
- [Erlend] will try to dig up previous discussions; maybe there are some in the
python-dev archive; will post a summary on the
[gh-108202](https://github.com/python/cpython/issues/108202) issue in a few days

- [Carol] [from Nov] API navigation or tables on long pages:
<https://discuss.python.org/t/summary-tables-as-an-api-overview/68474>

- [python/cpython#125810](https://github.com/python/cpython/pull/125810) ->
[docs.python.org/3/library/math.html](https://docs.python.org/3/library/math.html)
[merged!]
- [python/cpython#126342](https://github.com/python/cpython/pull/126342) ->
[cpython-previews--126342.org.readthedocs.build/en/126342/library/pathlib.html#summary](https://cpython-previews--126342.org.readthedocs.build/en/126342/library/pathlib.html#summary)
- Petr to figure out the Sphinx side of how to solve this, then ping Trey to polish
the CSS

- Translation dashboard
- [m-aciek.github.io/pydocs-translation-dashboard](https://m-aciek.github.io/pydocs-translation-dashboard/)
- [m-aciek/pydocs-translation-dashboard](https://github.com/m-aciek/pydocs-translation-dashboard)

## Next meeting

The docs team generally meets on the first Tuesday of every month around 20:00-ish UTC.

We have a recurring Google Calendar event for the meeting. Let Mariatta know your email
address and she can invite you.
1 change: 1 addition & 0 deletions docs/monthly-meeting/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ Monthly reports in chronological order.
Sep 2024 <2024-09.md>
Oct 2024 <2024-10.md>
Nov 2024 <2024-11.md>
Dec 2024 <2024-12.md>
Loading