Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Ezio Melotti <[email protected]>
  • Loading branch information
hugovk and ezio-melotti authored Jun 27, 2024
1 parent b329308 commit a49420a
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions docs/monthly-meeting/2024-06.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,23 @@ Please take a second to read through it!
but it would probably be better to merge with this already set up

- [Carol]
- PyCon Highlights
- Dinner with cross-section of core devs, educators, and authors
- Sprint contribute to docs feedback
- Sprint discussions
- [Draft Guiding Principles for Documentation](https://drive.google.com/file/d/1elKNdRPTIoNe6EZ4TbS9aquM-RaNDgmc/view)
- [Draft meeting notes from yesterday](https://docs.google.com/document/d/1NkaA4LMltE_GISN5v52bWfxA_QGcRxw6U3jzwFQ7c_c/edit?usp=sharing)
- [Editorial Board Repo](https://github.com/python/editorial-board) (share feedback here)
- Open an issue to ask for a decision
- Moving docs from Google Drive to the repo for visibility
- If folks get blocked, opening an issue on the EB repo is a good way to get in touch.
- The devguide serves the core dev community more than the general docs community.
We'll want to put guidelines in the docs repo instead. We'll move slow enough to not disrupt the devguide.
We'll make it accessible to folks who want to contribute more frequently.
- [Hugo] Yes, the first step in the devguide is to build CPython. Not ideal
- [Carol] We had folks like Melanie and Shauna go through the guide and take notes.
We're planning to put the guide on docsguide.python.org; open it up.
- Feel free to open issues on the EB repo to give Ned notes & feedback.
- PyCon Highlights
- Dinner with cross-section of core devs, educators, and authors
- Sprint contribute to docs feedback
- Sprint discussions
- [Draft Guiding Principles for Documentation](https://drive.google.com/file/d/1elKNdRPTIoNe6EZ4TbS9aquM-RaNDgmc/view)
- [Draft meeting notes from yesterday](https://docs.google.com/document/d/1NkaA4LMltE_GISN5v52bWfxA_QGcRxw6U3jzwFQ7c_c/edit?usp=sharing)
- [Editorial Board Repo](https://github.com/python/editorial-board) (share feedback here)
- Open an issue to ask for a decision
- Moving docs from Google Drive to the repo for visibility
- If folks get blocked, opening an issue on the EB repo is a good way to get in touch.
- The devguide serves the core dev community more than the general docs community.
We'll want to put guidelines in the docs repo instead. We'll move slow enough to not disrupt the devguide.
We'll make it accessible to folks who want to contribute more frequently.
- [Hugo] Yes, the first step in the devguide is to build CPython. Not ideal
- [Carol] We had folks like Melanie and Shauna go through the guide and take notes.
We're planning to put the guide on docsguide.python.org; open it up.
- Feel free to open issues on the EB repo to give Ned notes & feedback.

- Packaging summit: we're serving 2 groups of users with packaging: producers and consumers.
There was some discussion about user research, to make it easier to install packages etc.,
Expand Down Expand Up @@ -134,6 +134,8 @@ Please take a second to read through it!
- [Hugo] We've historically intentionally kept docstrings shorter.
The Python documentation is duplicated --
both in the docstrings and the main docs.
- [Ezio] Docstrings should just serve as quick reminders,
they are not supposed to be exhaustive.
- [Carol] Some of my thoughts are framed from Jupyter & intellisense experience.
Historically, info under hover came from the docstrings.
It's not the only possible source.
Expand Down

0 comments on commit a49420a

Please sign in to comment.