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 536: Mark as Withdrawn #3510

Merged
merged 11 commits into from
Oct 26, 2023
Merged

PEP 536: Mark as Withdrawn #3510

merged 11 commits into from
Oct 26, 2023

Conversation

flying-sheep
Copy link
Contributor

@flying-sheep flying-sheep commented Oct 24, 2023

Fixes python/steering-council#209

  • Author has withdrawn and linked to “discussion”
  • Pull request title in appropriate format (PEP 123: Mark as Accepted)
  • Status changed to Withdrawn
  • Resolution link points directly to author’s withdrawal post
  • Withdrawal notice added
  • Discussions-To, Post-History and Python-Version up to date

I’m unclear what the fields of the last point should be


📚 Documentation preview 📚: https://pep-previews--3510.org.readthedocs.build/

@flying-sheep flying-sheep requested a review from a team as a code owner October 24, 2023 13:49
@JelleZijlstra
Copy link
Member

Ideally Post-History should link to the old mailing list posts about the PEP, but I'm OK proceeding without that if it's too much work to dig them up.

@flying-sheep
Copy link
Contributor Author

flying-sheep commented Oct 24, 2023

hmm, I found

Which one would it be?

@brettcannon
Copy link
Member

@flying-sheep It can be all three; see https://peps.python.org/pep-0012/ for how to do that.

@flying-sheep
Copy link
Contributor Author

I followed the syntax in the document you linked, now the linter yells at me.

peps/pep-0536.rst Outdated Show resolved Hide resolved
@flying-sheep
Copy link
Contributor Author

There we go! The linter didn’t catch some newline sneaking in, now it does.

@hugovk
Copy link
Member

hugovk commented Oct 26, 2023

Please could you make the check-peps.py changes in another PR?

Because when I run pre-commit from main with this rogue newline:

Post-History: `18-Aug-2016 <https://mail.python.org/archives/list/[email protected]/thread/FOYKXOFWEINPVQSK2XGEHKXSTEVO5WWA/
>`__,
              `23-Dec-2016 <https://mail.python.org/archives/list/[email protected]/thread/YKKEA5NIMMKHZTMRE5UFHST4WQ4NN3XJ/>`__,
              `15-Mar-2019 <https://mail.python.org/archives/list/[email protected]/thread/N43O4KNLZW4U7YZC4NVPCETZIVRDUVU2/>`__

It's caught by two checks:

$ pre-commit run --all-files
Found existing alias for "pre-commit run --all-files". You should use: "pcr"
Normalize mixed line endings......................................................Passed
Sort codespell ignore list........................................................Passed
Check for case conflicts..........................................................Passed
Check for merge conflict markers..................................................Passed
Check that executables have shebangs..............................................Passed
Check that shebangs are executable................................................Passed
Check that VCS links are permalinks...............................................Passed
Check JSON........................................................................Passed
Check TOML........................................................................Passed
Check YAML........................................................................Passed
Format with Black.................................................................Passed
Lint with Ruff....................................................................Passed
Format tox.ini....................................................................Passed
Sphinx lint.......................................................................Passed
Check RST: No single backticks....................................................Passed
Check RST: No backticks touching text.............................................Passed
Check RST: 2 colons after directives..............................................Passed
PEPs must have all required headers...............................................Passed
PEP header order must follow PEP 12...............................................Failed
- hook id: check-header-order
- exit code: 1

peps/pep-0536.rst

'PEP' header must be a number 1-9999..............................................Passed
'Title' must be 1-79 characters...................................................Passed
'Author' must be list of 'Name <[email protected]>, ...'..........................Passed
'Sponsor' must have format 'Name <[email protected]>'.............................Passed
'Delegate' must have format 'Name <[email protected]>'............................Passed
'Discussions-To' must be a thread URL.............................................Passed
'Status' must be a valid PEP status...............................................Passed
'Type' must be a valid PEP type...................................................Passed
'Topic' must be for a valid sub-index.............................................Passed
'Content-Type' must be 'text/x-rst'...............................................Passed
`Requires`/`Replaces`/`Superseded-By` must be 'NNN' PEP IDs.......................Passed
'Created' must be a 'DD-mmm-YYYY' date............................................Passed
'Python-Version' must be a 'X.Y[.Z]` version......................................Passed
'Post-History' must be '`DD-mmm-YYYY <Thread URL>`__, ...'........................Failed
- hook id: validate-post-history
- exit code: 1

peps/pep-0536.rst:11:Post-History: `18-Aug-2016 <https://mail.python.org/archives/list/[email protected]/thread/FOYKXOFWEINPVQSK2XGEHKXSTEVO5WWA/

'Resolution' must be a direct thread/message URL..................................Passed
Check that PEPs aren't linked directly............................................Passed
Check that RFCs aren't linked directly............................................Passed

@flying-sheep
Copy link
Contributor Author

Sure. But without the change, the check-peps output looks like this:

image

So what I do makes it clearer.

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Please formally reject PEP-536
4 participants