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 legacy Author field format
  • Loading branch information
@CAM-Gerlach
CAM-Gerlach committed Apr 20, 2022
commit eff7423dbaed89d21f9e5792cc00981ae4fbbdc9
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,13 @@ repos:
files: '^pep-\d+\.(rst|txt)$'
exclude: '^pep-(0499)\.(rst|txt)$'
types: [text]
- id: validate-author-legacy
name: "Validate PEP 'Author' field (legacy)"
language: pygrep
entry: '(?<=\n)Author:(?:(?!((((( +|\n {8})[^!#$%&()*+,/:;<=>?@\[\\\]\^_`{|}~]+( <[\w!#$%&''*+\-/=?^_{|}~.]+(@| at )[\w\-.]+\.[A-Za-z0-9]+>)?)(,|(?=\n[^ ])))+)|(((( +|\n {8})[\w!#$%&''*+\-/=?^_{|}~.]+(@| at )[\w\-.]+\.[A-Za-z0-9]+) \(([^!#$%&()*+,/:;<=>?@\[\\\]\^_`{|}~]+)\)(,|(?=\n[^ ])))+))\n(?=[A-Z])))'
args: [--multiline]
files: '^pep-\d+\.txt$'
types: [text]
- id: validate-sponsor
name: "Validate PEP 'Sponsor' field"
language: pygrep
Expand Down
2 changes: 1 addition & 1 deletion pep-0246.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Title: Object Adaptation
Version: $Revision$
Last-Modified: $Date$
Author: aleaxit@gmail.com (Alex Martelli),
cce@clarkevans.com (Clark C. Evans)
cce@clarkevans.com (Clark C. Evans)
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0263.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Title: Defining Python Source Code Encodings
Version: $Revision$
Last-Modified: $Date$
Author: mal@lemburg.com (Marc-André Lemburg),
martin@v.loewis.de (Martin von Löwis)
martin@v.loewis.de (Martin von Löwis)
Status: Final
Type: Standards Track
Content-Type: text/x-rst
Expand Down
3 changes: 2 additions & 1 deletion pep-0282.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ PEP: 282
Title: A Logging System
Version: $Revision$
Last-Modified: $Date$
Author: vinay_sajip at red-dove.com (Vinay Sajip), trentm@activestate.com (Trent Mick)
Author: vinay_sajip at red-dove.com (Vinay Sajip),
trentm@activestate.com (Trent Mick)
Status: Final
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0310.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Title: Reliable Acquisition/Release Pairs
Version: $Revision$
Last-Modified: $Date$
Author: Michael Hudson <mwh@python.net>,
Paul Moore <p.f.moore@gmail.com>
Paul Moore <p.f.moore@gmail.com>
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-0372.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 372
Title: Adding an ordered dictionary to collections
Version: $Revision$
Last-Modified: $Date$
Author: Armin Ronacher <armin.ronacher@active-4.com>
Author: Armin Ronacher <armin.ronacher@active-4.com>,
Raymond Hettinger <python@rcn.com>
Status: Final
Type: Standards Track
Expand Down
2 changes: 1 addition & 1 deletion pep-0477.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 477
Title: Backport ensurepip (PEP 453) to Python 2.7
Version: $Revision$
Last-Modified: $Date$
Author: Donald Stufft <donald@stufft.io>
Author: Donald Stufft <donald@stufft.io>,
Nick Coghlan <ncoghlan@gmail.com>
BDFL-Delegate: Benjamin Peterson <benjamin@python.org>
Status: Final
Expand Down
2 changes: 1 addition & 1 deletion pep-0754.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 754
Title: IEEE 754 Floating Point Special Values
Version: $Revision$
Last-Modified: $Date$
Author: Gregory R. Warnes <gregory_r_warnes@groton.pfizer.com> (Pfizer, Inc.)
Author: Gregory R. Warnes <gregory_r_warnes@groton.pfizer.com>
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-3111.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 3111
Title: Simple input built-in in Python 3000
Version: $Revision$
Last-Modified: $Date$
Author: Andre Roberge <andre.roberge at gmail.com >
Author: Andre Roberge <andre.roberge at gmail.com>
Status: Final
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-3138.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 3138
Title: String representation in Python 3000
Version: $Revision$
Last-Modified: $Date$
Author: Atsuo Ishimoto <ishimoto--at--gembook.org>
Author: Atsuo Ishimoto <ishimoto at gembook.org>
Status: Final
Type: Standards Track
Content-Type: text/x-rst
Expand Down
2 changes: 1 addition & 1 deletion pep-3140.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Title: str(container) should call str(item), not repr(item)
Version: $Revision$
Last-Modified: $Date$
Author: Oleg Broytman <phd@phdru.name>,
Jim J. Jewett <jimjjewett@gmail.com>
Jim J. Jewett <jimjjewett@gmail.com>
Discussions-To: python-3000@python.org
Status: Rejected
Type: Standards Track
Expand Down
2 changes: 1 addition & 1 deletion pep-3145.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PEP: 3145
Title: Asynchronous I/O For subprocess.Popen
Version: $Revision$
Last-Modified: $Date$
Author: (James) Eric Pruitt, Charles R. McCreary, Josiah Carlson
Comment thread
hugovk marked this conversation as resolved.
Author: Eric Pruitt, Charles R. McCreary, Josiah Carlson
Status: Withdrawn
Type: Standards Track
Content-Type: text/x-rst
Expand Down