You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/monthly-meeting/2024-02.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,10 +53,11 @@ Please take a second to read through it!
53
53
[Ezio] We should start adding examples.
54
54
55
55
[Ezio] We should also figure out what to do about collapsible sections.
56
-
[Ned] What problem are collapsible sections solving? Do we have too many examples that users will want to ignore? (In my docs I use tabs, but not colapsible sections)
56
+
[Ned] What problem are collapsible sections solving? Do we have too many examples that users will want to ignore? (In my docs I use tabs, but not collapsible sections)
57
57
[Ezio] If we agree to add basic examples inline, but bigger examples on the bottom, we won't need collapsible sections.
58
58
[Carol] So: yes examples, yes inline. We can pause discussions about collapsible sections; if the examples get too long we should think about spinning them out into their own howto pages. **Consensus Recap**
59
-
59
+
[Ezio] We could create a custom Sphinx directive that creates a link to the "Examples" section too. It should be unobtrusive and recognizable (it could have an icon, and a short text like "See more examples.").
60
+
60
61
[Ezio] Would it make sense to do different things based on the builder, e.g. collapsible sections for HTML and something else for PDF?
61
62
[CAM] Yes. Some current directives for collapsible sections do that.
62
63
@@ -75,11 +76,12 @@ Please take a second to read through it!
75
76
[Daniele] I always call them *howto guides*: `HOWTO` sounds like an old-school passcode
76
77
[Carol] Could we use local ToC trees to split up the section?
77
78
[Hugo] We could fix that quickly if someone wants to make a PR
78
-
[Ezio] I think there was a discussion, will try to find it later. I was looking at the Unicode guide, which starts out as explanation but then turns into a howto guide, and sometimes it feels like a tutorial. There's an [issue about rewriting it](https://github.com/python/cpython/issues/107583), but I'm not sure how to do that
79
+
[Ezio] I was looking at the Unicode guide, which starts out as explanation but then turns into a howto guide, and sometimes it feels like a tutorial. There's an [issue about rewriting it](https://github.com/python/cpython/issues/107583), but I'm not sure what would be the best way to rewrite/reorganize it.
79
80
[Carol] The Linux project created both alphabetical and chronological lists of “HOWTO”s. Eventually, we can orphan the current format of the landing page.
80
81
[Carol] One of the urgent tasks is to set the reader's expectations. We don't want them to expect a modern howto and then not get it.
81
82
82
83
-[Hugo] The detailed changelog is very long -- longer than Moby Dick. ([python/docs-community#98](https://github.com/python/docs-community/issues/98))
84
+
[Ezio] Long ago I added an inputbox to filter entries, but [it appears to be broken now](https://github.com/python/cpython/issues/115317). This doesn't make the source page any shorter though.
0 commit comments