Skip to content

PEP 1 and 12: Document Topic header #2995

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.

Sign up for GitHub

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

Jump to bottom
Merged
hugovk merged 7 commits into from
Feb 3, 2023
Merged

PEP 1 and 12: Document Topic header #2995

hugovk merged 7 commits into from
Feb 3, 2023

Conversation

@hugovk
Copy link
Member

@hugovk hugovk commented Jan 31, 2023

Document the Topic header in PEPs 1 and 12.

As suggested by @warsaw in #2986 (comment).

The Governance topic will be added in #2993.

@hugovk hugovk mentioned this pull request Jan 31, 2023
Merged
warsaw
warsaw approved these changes Jan 31, 2023
View reviewed changes
Copy link
Member

@warsaw warsaw left a comment

Choose a reason for hiding this comment

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

Approved, with comment

CAM-Gerlach
CAM-Gerlach reviewed Feb 1, 2023
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

It should also be added to the header listing under How to use this template in PEP 12, and maybe also as a short bullet point there.

hugovk and others added 2 commits February 1, 2023 18:46
@hugovk @CAM-Gerlach
Review updates
d33389e 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@hugovk
Redirect topics to topic/
930c77e
CAM-Gerlach
CAM-Gerlach reviewed Feb 2, 2023
View reviewed changes
@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Feb 2, 2023

Oh, and just to be sure, still missing:

It should also be added to the header listing under How to use this template in PEP 12, and maybe also as a short bullet point there.

@CAM-Gerlach CAM-Gerlach mentioned this pull request Feb 2, 2023
Merged
hugovk and others added 4 commits February 2, 2023 12:51
@hugovk @CAM-Gerlach
Update topics->topic redirect
481761e 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@hugovk @CAM-Gerlach
Singular topic
c5a5811 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@hugovk
Add topic header to PEP 12
d75d4cd
@hugovk
Add htmlview target to Makefile
16f6d7a
@hugovk
Copy link
Member Author

hugovk commented Feb 2, 2023 •
edited by pradyunsg
Loading

Thanks, updated!

I also added an htmlview target to the Makefile, consistent with CPython docs and Devguide. Let me know if this should be in a separate PR. My fingers will be thankful, especially as the docs are output to three different directories: build, build/html, _build/html!

CAM-Gerlach
CAM-Gerlach approved these changes Feb 3, 2023
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @hugovk

warsaw
warsaw approved these changes Feb 3, 2023
View reviewed changes
Copy link
Member

@warsaw warsaw left a comment

Choose a reason for hiding this comment

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

Approved, with suggestion

@hugovk hugovk merged commit e92c4d6 into python:main Feb 3, 2023
@hugovk hugovk deleted the meta-add-topic-to-peps-1-and-12 branch February 3, 2023 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@warsaw warsaw warsaw approved these changes

@pradyunsg pradyunsg pradyunsg approved these changes

@CAM-Gerlach CAM-Gerlach CAM-Gerlach approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

@ewdurbin ewdurbin Awaiting requested review from ewdurbin ewdurbin is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@hugovk @CAM-Gerlach @warsaw @pradyunsg