GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — Add meeting note from Feb 2024 by Unique-Usman · Pull Request #106 · python/docs-community

Conversation

Unique-Usman commented Feb 10, 2024 •

edited by hugovk

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Contributor

📚 Documentation preview 📚: https://docs-community--106.org.readthedocs.build/en/106/monthly-meeting/2024-02.html

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Unique-Usman and others added 3 commits

February 11, 2024 02:23


          Add meeting note from Feb 2024

9e0d69f


          Merge branch 'usma' of https://github.com/Unique-Usman/docs-community …

f3bfb59

…into usma


          [pre-commit.ci] auto fixes from pre-commit.com hooks

53be5d3

for more information, see https://pre-commit.ci

egeakman reviewed

Feb 10, 2024

View reviewed changes

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

egeakman commented Feb 10, 2024

Copy link

Copy Markdown

Contributor

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

hugovk reacted with thumbs up emoji

All reactions

👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Unique-Usman and others added 2 commits

February 11, 2024 04:11


          Update docs/monthly-meeting/2024-02.md

3ab37ef

Co-authored-by: Ege Akman <[email protected]>


          Apply suggestions from code review

dc68872

Co-authored-by: Ege Akman <[email protected]>

egeakman reviewed

Feb 11, 2024

View reviewed changes

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.


          Update docs/monthly-meeting/2024-02.md

ab631d5

Co-authored-by: Ege Akman <[email protected]>

egeakman commented Feb 11, 2024 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Contributor

I am not sure about this style:

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

ezio-melotti mentioned this pull request

Feb 11, 2024

gh-106318: Add examples for the str methods in collapsible sections python/cpython#111743

Closed

ezio-melotti reviewed

Feb 12, 2024

View reviewed changes

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Outdated

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

ezio-melotti Feb 12, 2024

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

ezio-melotti commented Feb 12, 2024

Copy link

Copy Markdown

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?

egeakman reacted with thumbs up emoji

All reactions

👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Unique-Usman and others added 3 commits

February 12, 2024 17:49


          Apply suggestions from code review

9f08369

Co-authored-by: Ezio Melotti <[email protected]>


          [pre-commit.ci] auto fixes from pre-commit.com hooks

c0b9c2b

for more information, see https://pre-commit.ci


          Update docs/monthly-meeting/2024-02.md

f4da79c

Co-authored-by: Ezio Melotti <[email protected]>

ezio-melotti reviewed

Feb 12, 2024

View reviewed changes

Comment thread

docs/monthly-meeting/2024-02.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Unique-Usman and others added 2 commits

February 16, 2024 10:56


          Update docs/monthly-meeting/2024-02.md

fb01034

Co-authored-by: Ezio Melotti <[email protected]>


          [pre-commit.ci] auto fixes from pre-commit.com hooks

e36c7d4

for more information, see https://pre-commit.ci

egeakman approved these changes

Feb 16, 2024

View reviewed changes

willingc approved these changes

Feb 18, 2024

View reviewed changes

willingc left a comment

Copy link

Copy Markdown

Collaborator

There was a problem hiding this 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 ☀️

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

willingc commented Feb 19, 2024

Copy link

Copy Markdown

Collaborator

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

ezio-melotti reacted with thumbs up emoji

All reactions

👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

willingc merged commit 1001ac1 into python:main

Feb 19, 2024

Unique-Usman deleted the usma branch

March 20, 2024 18:02

Reviewers

ezio-melotti

ezio-melotti left review comments

willingc

willingc approved these changes

+1 more reviewer

egeakman

egeakman approved these changes

Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

Conversation

Unique-Usman commented Feb 10, 2024 • edited by hugovk Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

egeakman commented Feb 10, 2024

Uh oh!

Uh oh!

egeakman commented Feb 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ezio-melotti Feb 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ezio-melotti commented Feb 12, 2024

Uh oh!

Uh oh!

willingc left a comment

Choose a reason for hiding this comment

Uh oh!

willingc commented Feb 19, 2024

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Unique-Usman commented Feb 10, 2024 •

edited by hugovk

Loading

Uh oh!

There was an error while loading. Please reload this page.

egeakman commented Feb 11, 2024 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.