Skip to content

Commit 12cd1da

Browse files
Unique-Usmannedbat
andauthored
Update docs/monthly-meeting/2024-01.md
Co-authored-by: Ned Batchelder <[email protected]>
1 parent 80c9ae6 commit 12cd1da

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/monthly-meeting/2024-01.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ Please take a second to read through it!
6666
- [Jim] It sounds like the framing of this discussion is, source text targeting a big module documentation page with docs for all that module's methods. There are other possible targets: docstrings, tooltips text. Are there other targets for doc source which we should consider in this discussion?
6767
- [Ned] We write docs twice -- once for the docstrings and once in `rst`. That's more work, but it means we can have different strategies for each use case.
6868
- [Guido] Changing that would involve several PEPs.
69+
- [Ned] Right, I wasn't suggesting we change it, just ensuring everyone knew.
6970
- [CAM] Sphinx has ways to generate docs for a whole module, or just a single function, from docstrings. But yes, starting to use that would need a PEP.
7071
- [CAM] The strategy we took for `sqlite3` was to focus on the functions with most arguments, where the bulleted lists have most benefit, and leave the smaller functions for later, when we have more experience with the approach.
7172
- [Carol] And we should keep in mind that our perspectives are not necessarily the users' perspective. If we do make major changes we should think about users and we should vet the changes.

0 commit comments

Comments
 (0)