Skip to content

Commit 9f08369

Browse files
Apply suggestions from code review
Co-authored-by: Ezio Melotti <[email protected]>
1 parent ab631d5 commit 9f08369

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/monthly-meeting/2024-02.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,11 @@ Please take a second to read through it!
5353
[Ezio] We should start adding examples.
5454

5555
[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)
5757
[Ezio] If we agree to add basic examples inline, but bigger examples on the bottom, we won't need collapsible sections.
5858
[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+
6061
[Ezio] Would it make sense to do different things based on the builder, e.g. collapsible sections for HTML and something else for PDF?
6162
[CAM] Yes. Some current directives for collapsible sections do that.
6263

@@ -75,11 +76,12 @@ Please take a second to read through it!
7576
[Daniele] I always call them *howto guides*: `HOWTO` sounds like an old-school passcode
7677
[Carol] Could we use local ToC trees to split up the section?
7778
[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.
7980
[Carol] The Linux project created both alphabetical and chronological lists of “HOWTO”s. Eventually, we can orphan the current format of the landing page.
8081
[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.
8182

8283
- [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.
8385

8486

8587
## Next meeting

0 commit comments

Comments
 (0)