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 meeting note from Feb 2024 #106

Merged
merged 11 commits into from
Feb 19, 2024
Merged

Add meeting note from Feb 2024 #106

merged 11 commits into from
Feb 19, 2024

Conversation

Unique-Usman
Copy link
Contributor

@Unique-Usman Unique-Usman commented Feb 10, 2024

docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
@egeakman
Copy link
Contributor

If the items in "Follow-ups from previous meeting(s)" were not discussed, we should probably remove this section.

Unique-Usman and others added 2 commits February 11, 2024 04:11
Co-authored-by: Ege Akman <egeakmanegeakman@hotmail.com>
Co-authored-by: Ege Akman <egeakmanegeakman@hotmail.com>
Co-authored-by: Ege Akman <egeakmanegeakman@hotmail.com>
@egeakman
Copy link
Contributor

egeakman commented Feb 11, 2024

I am not sure about this style:
image

I personally would prefer something like:

  • [Ezio] Adding examples to the docs...
    • [Dainele] Examples work best as ...
    • [Ezio] Maybe we should ...
    • [Daniele] An example sections sounds like ...
    • [Ned] I like examples for ...

just feels easier to read IMHO.

docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
Comment on lines 55 to 64
[Ezio] We should also figure out what to do about collapsible sections.
[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)
[Ezio] If we agree to add basic examples inline, but bigger examples on the bottom, we won't need collapsible sections.
[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**

[Ezio] Would it make sense to do different things based on the builder, e.g. collapsible sections for HTML and something else for PDF?
[CAM] Yes. Some current directives for collapsible sections do that.

[Ned] re. pages being too long, we might switch to having a page for each function
[Carol] we could run a cron job to count lines
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part seems a bit jumbled together (not sure if the conversation was, or if the discussion was transcribed out of order).

First of all it's missing some context, such as the problems that collapsible sections, such as that they don't work with different builders. I would put this near the top, since the whole discussion becomes moot if we don't use them.

Regarding page length (and specifically examples length, if counted with something smarter than a wc -l), the script could be used both for pages with not enough examples (so we should add more), and pages that have too many (they might be better moved to the "Examples" section or a separate page).

I would close with Carol's summary.

P.S. I'm not sure if @nedbat suggested having a page for each function, I think it was @hugovk to bring this up while talking about PHP docs, but I might be misremembering.

docs/monthly-meeting/2024-02.md Outdated Show resolved Hide resolved
docs/monthly-meeting/2024-02.md Show resolved Hide resolved
@ezio-melotti
Copy link
Member

I am not sure about this style:

I find the transcript a bit difficult to read, since it tries to follow the (sometime erratic) conversations. This style also makes it difficult to add more comments, notes, and clarification afterwards.

Maybe we should try to summarize each conversation with a few bullets points and either get rid of the (already abridged) transcript or move it to a separate section.

@CAM-Gerlach, any thoughts about this?

Unique-Usman and others added 3 commits February 12, 2024 17:49
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Unique-Usman and others added 2 commits February 16, 2024 10:56
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Copy link
Collaborator

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding the notes PR ☀️

@willingc
Copy link
Collaborator

I am going to go ahead and merge this. We can make any corrections or style changes in a separate PR. Thanks everyone.

@willingc willingc merged commit 1001ac1 into python:main Feb 19, 2024
4 checks passed
@Unique-Usman Unique-Usman deleted the usma branch March 20, 2024 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants