Commit Graph

33 Commits

Author SHA1 Message Date
Hugo van Kemenade d2d6d71319
Meta: Document the PEPs API (#3864)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-16 23:04:03 -06:00
Hugo van Kemenade ed037e66b7
Meta: Update config (#3645) 2024-02-08 18:43:54 +02:00
Hugo van Kemenade e9192948f9
Meta: Update pre-commit to fix Sphinx Lint (#3585)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-12-12 17:06:18 +00:00
Hugo van Kemenade 3b5f6f4464
PEP 1 and 12: Remove optional Content-Type from templates (#3454) 2023-09-28 02:00:23 +01:00
Hugo van Kemenade 2868fe9c84
Lint: Update Ruff config (#3433) 2023-09-10 16:04:40 +01:00
Adam Turner 08d688fdca
All PEPs: Move to ``peps/`` folder (#3418) 2023-09-09 18:39:29 +01:00
Adam Turner 0f22268963
Lint: Add Ruff (#3429) 2023-09-09 17:33:52 +01:00
Adam Turner 814ceede97
Lint: Add ``check-peps.py`` (#3275)
``check-peps`` codifies the rules in PEP 1 and PEP 12 into a single
place containing all of the PEP-specific checks. These are primarily
header and metadata validation, and ensuring that direct links to
RFCs and PEPs aren't used.

Reviewed-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Reviewed-by: C.A.M. Gerlach <cam.gerlach@gerlach.cam>
2023-09-05 04:44:46 +01:00
Adam Turner 678bc9b8d3
Lint: Enable pre-commit default role checks (#3415) 2023-09-01 20:41:07 +01:00
shailshouryya 0ebf5a4390
Lint: Update outdated package dependencies & reformat files (#3291)
* Update `sphinx-lint` package dependency version number → 0.6.8

This new release includes the changes from
https://github.com/sphinx-contrib/sphinx-lint/pull/56/files,
which should address
https://github.com/python/peps/issues/3028. For details
about `sphinx-lint` release 0.6.8, see
https://github.com/sphinx-contrib/sphinx-lint/releases/tag/v0.6.8.

* Update other outdated dependencies

Run the following:

```
python -m pip install pre-commit
pre-commit autoupdate
pre-commit run --all-files
```
2023-08-16 08:07:57 +03:00
C.A.M. Gerlach f292166dba
Lint: Allow per-message Post-History links w/trailing slash (#3005)
* Lint: Only ignore per-message links in Post-History with trailing slash
* PEP 684: Add trailing slash to per-message Post-History link
* Infra: Use clearer term (message, not post) for single Discourse messages
2023-02-06 16:49:00 -06:00
Eric Snow bb50330507
PEP 684: Minor Updates (#3004)
I had forgotten to update the Post-History header back in October. There was also one minor point from that round of discussion that I had not added to the PEP yet.
2023-02-03 15:49:21 -07:00
Hugo van Kemenade 5bdec964da
Meta: Add a governance topic (#2993)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
Fixes https://github.com/python/peps/issues/2987
2023-02-02 12:50:01 +02:00
Hugo van Kemenade b6ac1faea8
Infra: Update precommit to fix Poetry (#2994) 2023-01-31 10:36:17 +02:00
C.A.M. Gerlach 82d2996b38
Lint: Add a new check for consistent PEP header order (#2835)
* Lint: Clarify name/ID of required header check

* PEP 440: Fix header ordering

* PEP 441: Fix header ordering

* PEP 523: Fix header ordering

* PEP 612: Fix spurious top-level title section heading

* Lint: Add new check for consistant PEP header order
2022-10-15 21:09:24 -07:00
C.A.M. Gerlach e1c7bce5b5
Lint: Upgrade linters, enable backtick check & fix new errors (#2825)
* PEP 240: Fix issue detected by Sphinx-Lint
* PEP 357: Fix issue detected by Sphinx-Lint
* PEP 447: Fix issue detected by Sphinx-Lint
* PEP 461: Fix issue detected by Sphinx-Lint
* Lint: Autoupdate pre-commit hook versions
* Lint: Re-enable --role-with-double-backticks now that FP is fixed
2022-10-14 00:01:49 -05:00
Jelle Zijlstra e46b83661d
Add Topic for release schedule PEPs (#2669)
Release PEPs are a pretty unusual kind of PEP and it's useful to me to have
them all listed together. Happy to adjust the name of the topic if desired.

I took the opportunity to adjust the status of a few release PEPs. Now all
releases for EOL versions are Final (3.5 was previously Active), and all
releases for released versions are Active (3.10 was still draft). 3.11 remains
Draft as 3.11 has not yet been released.

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-06 18:01:52 -07:00
Hugo van Kemenade 7fa80c34d7
Infra + many PEPs: Add Sphinx Lint and fix errors (#2816)
* PEP 555, 653: Fix inline literal missing (escaped) space after literal

* Add newline at end of file

* PEP 692: Add newline at end of file

* PEP 633: Fix missing space before role

* Run sphinx-lint in pre-commit

* PEP 639: Remove rogue backticks

* PEP 372: Remove rogue backticks

* PEP 462: Add missing underscore after closing backtick in hyperlink

* PEP 481: Add missing underscore after closing backtick in hyperlinks

* PEP 507: Add missing underscore after closing backtick in hyperlinks

* PEP 453: Add missing underscore after closing backtick in hyperlinks, and convert to links

* PEP 534: Fix inline literal missing (escaped) space after literal

* PEP 372, 453, 462: Redirect BPO to GH
2022-10-06 12:14:32 -07:00
Hugo van Kemenade 5fb8b28a06
Many PEPs: 'Author' must be list of 'Name <email@example.com>, ...' (#2809) 2022-10-05 19:48:43 +03:00
Eric Snow a9a5364c05
PEP 684: Updates for Round 1 of Discussions (gh-2800) 2022-09-29 16:51:03 -06:00
Pradyun Gedam 34e9a8d33f
Remove the requirement for Resolution to be the final header (#2678)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Pradyun Gedam <pradyunsg@users.noreply.github.com>
2022-06-29 16:31:12 -05:00
Adam Turner a2f2d6cc5a
Add support for topic indices (#2579)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-06-18 20:04:46 +02:00
Hugo van Kemenade 0b0dd6ddd5
Add tests for `pep_sphinx_extensions` (#2545)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-04-26 20:07:20 +01:00
CAM Gerlach a6336e9d74
Lint: Update headers and checks per current guidance & provide helpful feedback (#2484)
* Lint: Disable a couple potentially problematic/unneeded hooks

* Lint: Refine regex for existing Content-Type and PEP references checks

* Lint: Refine regex for Python-Version check and fix a couple deviations

* Lint: Refine regex for Created check and fix a couple deviations

* Lint: Refine regex for Resolution check and fix a few deviations

* Lint: Add new check for Post-History header

* Lint: Add check for Discussions-To header link

* Lint: Add basic check for PEP title presense & excessive length

* Lint: Add check for PEP/BDFL-Delegate header

* Lint: Add check for Sponsor header

* Lint: Add check for legacy Author field format

* Lint: Add check for RST Author field

* Lint: Use more helpful, user-oriented descriptions for header checks

* PEP 245: Add historical note and archive links to wiki page/email lsit

* PEP 628: Add direct link to resolution in acceptance message

* Lint: Explictly allow all valid RFC 2822 line continuations in headers

* Lint: Tweak Post-History and Resolution checks to accept fragments
2022-04-20 04:53:08 -05:00
CAM Gerlach d286a46470
PEP 1, 12: Update for adoption of PEP 676, and fix a few related items (#2447)
* PEP 1, 12: Update outdated references to Docutils to point to Sphinx

* PEP 1, 12: Update and simplify outdated legacy rendering workflow steps

* Readme: Fix minor issues introduced in PR #2399

* Infra: Update contents to include PEP rendering docs and avoid warnings

* Lint: Update hardcoded PEP link checker to detect new PEP URLs
2022-03-24 15:02:08 -05:00
CAM Gerlach a0dece9632
Lint: Implement check for spaces, not tabs per PEP 12 (#2379) 2022-03-05 20:46:59 +02:00
CAM Gerlach 52ffaebe9b
PEP 12: Update guidance on linking PEPs/RFCs per recent changes, and add check for it (#2291) 2022-02-02 19:52:40 -08:00
CAM Gerlach e43f567e93
Upgrade lint infra & add a few more conservative built-in checks (#2286) 2022-01-31 18:49:58 -08:00
Dimitri Papadopoulos Orfanos e5de01abae
Add configuration for running `codespell` locally (#2151)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-01-24 23:40:15 +00:00
Adam Turner cf5b6b1649 Fix resolution field validator 2022-01-21 00:46:25 +00:00
CAM Gerlach d548fdfb61
Lint: Validate PEP fields against PEP 12 (#1890) 2021-03-23 07:55:26 -07:00
CAM Gerlach e6fb0d8ca6
Validate PEP created dates and update linters (#1886)
* Check created date exists & matches format, and fix non-conforming

* Automatically fix mixed EoLs on checkin and in one PEP

* Add rst-directive-colons check, fix issue it found and refine regex
2021-03-22 12:29:08 -07:00
Hugo van Kemenade 58718c543e
Lint RST on GitHub Actions and fix PEP 646 (#1802) 2021-02-08 07:20:51 -08:00