FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

PEP 732: The Python Documentation Editorial Board by jablonskidev · Pull Request #3489 · python/peps · GitHub

/ peps Public

PEP 732: The Python Documentation Editorial Board - #3489

Merged
hugovk merged 16 commits into
python:mainfrom
jablonskidev:main
Oct 19, 2023
ConversationCommits (16)ChecksFiles changed
Merged

PEP 732: The Python Documentation Editorial Board#3489
hugovk merged 16 commits into
python:mainfrom
jablonskidev:main

Conversation

jablonskidev commented Oct 14, 2023 •
edited by Mariatta
Loading

Copy link
Copy Markdown
Contributor

Basic requirements (all PEP Types)

  • Read and followed PEP 1 & PEP 12
  • File created from the latest PEP template
  • PEP has next available number, & set in filename (pep-NNNN.rst), PR title (PEP 123: <Title of PEP>) and PEP header
  • Title clearly, accurately and concisely describes the content in 79 characters or less
  • Core dev/PEP editor listed as Author or Sponsor, and formally confirmed their approval
  • Author, Status (Draft), Type and Created headers filled out correctly
  • PEP-Delegate, Topic, Requires and Replaces headers completed if appropriate
  • Required sections included
    • Abstract (first section)
    • Copyright (last section; exact wording from template required)
  • Code is well-formatted (PEP 7/PEP 8) and is in code blocks, with the right lexer names if non-Python
  • PEP builds with no warnings, pre-commit checks pass and content displays as intended in the rendered HTML
  • Authors/sponsor added to .github/CODEOWNERS for the PEP

📚 Documentation preview 📚: https://pep-previews--3489.org.readthedocs.build/pep-0732/

jablonskidev requested a review from a team as a code owner October 14, 2023 14:00

hugovk commented Oct 14, 2023

Copy link
Copy Markdown
Member

Please use PEP number 732. 📚

hugovk reviewed Oct 14, 2023
View reviewed changes
Comment thread peps/pep-NNNN/pep-NNNN.rst
hugovk reviewed Oct 14, 2023
View reviewed changes
Comment thread peps/pep-NNNN/pep-NNNN.rst Outdated
Comment thread peps/pep-NNNN/pep-NNNN.rst Outdated
Mariatta reviewed Oct 16, 2023
View reviewed changes
Comment thread peps/pep-NNNN/pep-NNNN.rst Outdated
JelleZijlstra mentioned this pull request Oct 16, 2023
Merged
41 tasks
hugovk changed the title Editorial Board PEP PEP 732: The Python Documentation Editorial Board Oct 16, 2023
encukou added the new-pep A new draft PEP submitted for initial review label Oct 18, 2023

jablonskidev commented Oct 18, 2023

Copy link
Copy Markdown
Contributor Author

Thank you for your feedback and patience. The PEP now has the correct number and date. I also changed "DevGuide" to "devguide" to follow house style. Please let me know if you need any further action from me.

hugovk reviewed Oct 18, 2023
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks! I think we're almost there.

Please also update the .github/CODEOWNERS file with:

peps/pep-0732.*    @Mariatta

Comment thread peps/pep-0732.rst Outdated
Comment thread peps/pep-0732.rst Outdated
Comment thread peps/pep-0732.rst Outdated
Comment thread peps/pep-0732/docs-pep-concentric.drawio.svg
hugovk reviewed Oct 18, 2023
View reviewed changes
Comment thread peps/pep-0732.rst Outdated
Comment thread peps/pep-0732.rst Outdated
jablonskidev and others added 7 commits October 19, 2023 05:33
Update peps/pep-0732.rst
61fdba0 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Update peps/pep-0732.rst
5912723 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Update peps/pep-0732.rst
d52c110 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Update peps/pep-0732.rst
9416ecf 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Update peps/pep-0732.rst
2b771f1 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Add Mariatta for PEP 732
dae7345
Move image file and update reference in rst
530e55d

jablonskidev commented Oct 19, 2023

Copy link
Copy Markdown
Contributor Author

I applied your feedback. Please let me know if you need anything else.

Mariatta approved these changes Oct 19, 2023
View reviewed changes

Mariatta left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks!

hugovk reviewed Oct 19, 2023
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Finishing touches :)

Comment thread peps/docs-pep-concentric.drawio.svg
Comment thread peps/pep-0732.rst Outdated
jablonskidev and others added 2 commits October 19, 2023 07:24
Update peps/pep-0732.rst
ddd3400 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Add prefix to filename and update rst
aa02e37
hugovk approved these changes Oct 19, 2023
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thank you!

hugovk merged commit 54b14ed into python:main Oct 19, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk approved these changes
Mariatta Mariatta approved these changes

Assignees

No one assigned

Labels

new-pep A new draft PEP submitted for initial review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL