Fix copyright date with SOURCE_DATE_EPOCH set #21724
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When `SOURCE_DATE_EPOCH` is set, then Sphinx will attempt to 'fix' the year in the copyright: sphinx-doc/sphinx#3451 (comment) We already correctly understand that envvar, so this is unexpected and wrong. Sphinx looks for a 4-digit year followed by a space or two 4-digit years separated by a dash. We can fix this by using an en-dash, which is the correct typographical symbol for date ranges anyway, and thwarts Sphinx. Fixes matplotlib#20854
jklymak
reviewed
Nov 23, 2021
There was a problem hiding this comment.
Ha, sounds a bit fragile, but OK.
Is there a reason we maintain a range of dates like this, and oldest first? Is it really pertinent who held the original copyright? If we want to acknowledge the founding team, that could just as easily be:
'2021 Matplotlib; All rights reserved. Matplotlib was started by John Hunter, Darren Dale, Eric Firing, Michael Droettboom in 2002'
jklymak
approved these changes
Nov 23, 2021
|
I dunno; I'll leave copyright changes to the Governance people. |
|
Feel free to self-merge when the docs build and the copyright looks good.... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
When
SOURCE_DATE_EPOCHis set, then Sphinx will attempt to 'fix' the year in the copyright:sphinx-doc/sphinx#3451 (comment)
We already correctly understand that envvar, so this is unexpected and wrong.
Sphinx looks for a 4-digit year followed by a space or two 4-digit years separated by a dash. We can fix this by using an en-dash, which is the correct typographical symbol for date ranges anyway, and thwarts Sphinx.
Fixes #20854
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).