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

PEP 732: The Python Documentation Editorial Board #3489

Merged
merged 16 commits into from
Oct 19, 2023
Merged

PEP 732: The Python Documentation Editorial Board #3489

merged 16 commits into from
Oct 19, 2023

Conversation

jablonskidev
Copy link
Contributor

@jablonskidev jablonskidev commented Oct 14, 2023

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 jablonskidev requested a review from a team as a code owner October 14, 2023 14:00
@hugovk
Copy link
Member

hugovk commented Oct 14, 2023

Please use PEP number 732. 📚

peps/pep-NNNN/pep-NNNN.rst Outdated Show resolved Hide resolved
peps/pep-NNNN/pep-NNNN.rst Outdated Show resolved Hide resolved
peps/pep-NNNN/pep-NNNN.rst Outdated Show resolved Hide resolved
@hugovk hugovk changed the title Editorial Board PEP PEP 732: The Python Documentation Editorial Board Oct 16, 2023
@encukou encukou added the new-pep A new draft PEP submitted for initial review label Oct 18, 2023
@jablonskidev
Copy link
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.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks! I think we're almost there.

Please also update the .github/CODEOWNERS file with:

peps/pep-0732.*    @Mariatta

peps/pep-0732.rst Outdated Show resolved Hide resolved
peps/pep-0732.rst Outdated Show resolved Hide resolved
peps/pep-0732.rst Outdated Show resolved Hide resolved
peps/pep-0732/docs-pep-concentric.drawio.svg Outdated Show resolved Hide resolved
peps/pep-0732.rst Outdated Show resolved Hide resolved
peps/pep-0732.rst Outdated Show resolved Hide resolved
@jablonskidev
Copy link
Contributor Author

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

Copy link
Member

@Mariatta Mariatta left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Finishing touches :)

peps/docs-pep-concentric.drawio.svg Outdated Show resolved Hide resolved
peps/pep-0732.rst Outdated Show resolved Hide resolved
Copy link
Member

@hugovk hugovk 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!

@hugovk hugovk merged commit 54b14ed into python:main Oct 19, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-pep A new draft PEP submitted for initial review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants