Skip to content

Lint: Update headers and checks per current guidance & provide helpful feedback #2484

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

Merged
CAM-Gerlach merged 17 commits into from
Apr 20, 2022
Merged

Lint: Update headers and checks per current guidance & provide helpful feedback #2484

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
c826909
Lint: Disable a couple potentially problematic/unneeded hooks
CAM-Gerlach Mar 29, 2022
e03b73c
Lint: Refine regex for existing Content-Type and PEP references checks
CAM-Gerlach Mar 29, 2022
8df4c4d
Lint: Refine regex for Python-Version check and fix a couple deviations
CAM-Gerlach Mar 29, 2022
2c98989
Lint: Refine regex for Created check and fix a couple deviations
CAM-Gerlach Mar 29, 2022
e75643e
Lint: Refine regex for Resolution check and fix a few deviations
CAM-Gerlach Mar 29, 2022
7abaaf3
Lint: Add new check for Post-History header
CAM-Gerlach Mar 29, 2022
ad6ba56
Lint: Add check for Discussions-To header link
CAM-Gerlach Mar 29, 2022
dd30fff
Lint: Add basic check for PEP title presense & excessive length
CAM-Gerlach Mar 29, 2022
309ec3c
Lint: Add check for PEP/BDFL-Delegate header
CAM-Gerlach Mar 30, 2022
b3fef66
Lint: Add check for Sponsor header
CAM-Gerlach Mar 30, 2022
eff7423
Lint: Add check for legacy Author field format
CAM-Gerlach Mar 30, 2022
a829dff
Lint: Add check for RST Author field
CAM-Gerlach Mar 30, 2022
90add11
Lint: Use more helpful, user-oriented descriptions for header checks
CAM-Gerlach Mar 30, 2022
3712bba
PEP 245: Add historical note and archive links to wiki page/email lsit
CAM-Gerlach Mar 31, 2022
afd0a40
PEP 628: Add direct link to resolution in acceptance message
CAM-Gerlach Mar 31, 2022
b51cde8
Lint: Explictly allow all valid RFC 2822 line continuations in headers
CAM-Gerlach Apr 1, 2022
a894d22
Lint: Tweak Post-History and Resolution checks to accept fragments
CAM-Gerlach Apr 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Lint: Add check for Discussions-To header link
  • Loading branch information
@CAM-Gerlach
CAM-Gerlach committed Apr 20, 2022
commit ad6ba564b70e421b86f9d7d6915163ad5386ebbf
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ repos:
args: ['--multiline']
files: '^pep-\d+\.(rst|txt)$'
types: [text]
- id: validate-discussions-to
name: "Validate PEP 'Discussions-To' field"
language: pygrep
entry: '^Discussions-To: (?:(?!([\w\-]+@(python\.org|googlegroups\.com))|https://((discuss\.python\.org/t/([\w\-]+/)?\d+/?)|(mail\.python\.org/pipermail/[\w\-]+/\d{4}-[A-Za-z]+/[A-Za-z0-9]+\.html)|(mail\.python\.org/archives/list/[\w\-]+@python\.org/thread/[A-Za-z0-9]+/?))$))'
files: '^pep-\d+\.(rst|txt)$'
types: [text]
- id: validate-status
name: "Validate PEP 'Status' field"
language: pygrep
Expand Down
1 change: 0 additions & 1 deletion pep-0245.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Title: Python Interface Syntax
Version: $Revision$
Last-Modified: $Date$
Author: Michel Pelletier <michel@users.sourceforge.net>
Discussions-To: http://www.zope.org/Wikis/Interfaces
Comment thread
hugovk marked this conversation as resolved.
Resolved
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Expand Down
1 change: 0 additions & 1 deletion pep-0255.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Last-Modified: $Date$
Author: nas@arctrix.com (Neil Schemenauer),
tim.peters@gmail.com (Tim Peters),
magnus@hetland.org (Magnus Lie Hetland)
Discussions-To: python-iterators@lists.sourceforge.net
Comment thread
hugovk marked this conversation as resolved.
Resolved
Status: Final
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0387.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Version: $Revision$
Last-Modified: $Date$
Author: Benjamin Peterson <benjamin@python.org>
BDFL-Delegate: Brett Cannon (on behalf of the steering council)

@hugovk hugovk Mar 30, 2022

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.

There was a desire in #1672 to enforce PEP-Delegate in new PEPs but keep BDFL-Delegate in old ones.

@JelleZijlstra JelleZijlstra Mar 31, 2022

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.

Since this PEP is still "Active" it seems reasonable to change it

@CAM-Gerlach CAM-Gerlach Mar 31, 2022 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah, I didn't mass-change it; in this case though this PEP is explicitly stated to be approved on behalf of the Steering Council (rather than the BDFL) so I wanted to ensure that the header still reflected that.

Discussions-To: https://discuss.python.org/t/pep-387-backwards-compatibilty-policy/
Discussions-To: https://discuss.python.org/t/pep-387-backwards-compatibilty-policy/4421
Status: Active
Type: Process
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0480.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Author: Trishank Karthik Kuppusamy <karthik@trishank.com>,
Vladimir Diaz <vladimir.diaz@nyu.edu>,
Justin Cappos <jcappos@nyu.edu>, Marina Moore <mm9693@nyu.edu>
BDFL-Delegate: Donald Stufft <donald@stufft.io>
Discussions-To: https://discuss.python.org/c/packaging
Discussions-To: https://discuss.python.org/t/5666
Status: Draft
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0581.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Version: $Revision$
Last-Modified: $Date$
Author: Mariatta <mariatta@python.org>
BDFL-Delegate: Barry Warsaw <barry@python.org>
Discussions-To: https://discuss.python.org/c/core-workflow
Discussions-To: https://discuss.python.org/t/535
Status: Accepted
Type: Process
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0588.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 588
Title: GitHub Issues Migration Plan
Author: Mariatta <mariatta@python.org>
BDFL-Delegate: Barry Warsaw <barry@python.org>
Discussions-To: https://discuss.python.org/c/core-workflow
Discussions-To: https://discuss.python.org/t/13791
Status: Draft
Type: Informational
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0592.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 592
Title: Adding "Yank" Support to the Simple API
Author: Donald Stufft <donald@stufft.io>
BDFL-Delegate: Paul Moore <p.f.moore@gmail.com>
Discussions-To: https://discuss.python.org/c/packaging
Discussions-To: https://discuss.python.org/t/1629
Status: Final
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0599.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Last-Modified: $Date$
Author: Dustin Ingram <di@python.org>
Sponsor: Paul Moore <p.f.moore@gmail.com>
BDFL-Delegate: Paul Moore <p.f.moore@gmail.com>
Discussions-To: https://discuss.python.org/t/the-next-manylinux-specification/
Discussions-To: https://discuss.python.org/t/the-next-manylinux-specification/1043
Status: Superseded
Type: Informational
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0609.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Author: Dustin Ingram <di@python.org>,
Sumana Harihareswara <sh@changeset.nyc>
Sponsor: Paul Ganssle <paul@ganssle.io>
BDFL-Delegate: TBD
Discussions-To: https://discuss.python.org/t/pep-609-pypa-governance/
Discussions-To: https://discuss.python.org/t/pep-609-pypa-governance/2619
Status: Active
Type: Process
Content-Type: text/x-rst
Expand Down