Support placeholders for years in copyright #12910
Merged
Conversation
This file contains 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
# Conflicts: # sphinx/config.py
jayaddison
reviewed
Oct 4, 2024
jayaddison
reviewed
Oct 4, 2024
| @@ -27,7 +26,7 @@ | |||
| exclude_patterns = ['_build'] | |||
|
|
|||
| project = 'Sphinx' | |||
| copyright = f'2007-{time.strftime("%Y")}, the Sphinx developers' | |||
| copyright = '2007-%Y, the Sphinx developers' | |||
There was a problem hiding this comment.
Although I think we should support this templating for other projects, I have a strong preference for using constant/static copyright notices where possible (although I fully admit that adding supporting tooling to detect cases where they're out-of-date could be useful).
Given that, and the fact that we update most of the copyright notices throughout the codebase manually each year, I wonder whether we should do the same here.
Suggested change
| copyright = '2007-%Y, the Sphinx developers' | |
| copyright = '2007-2024, the Sphinx developers' |
jayaddison
reviewed
Oct 4, 2024
jayaddison
approved these changes
Oct 4, 2024
jayaddison
reviewed
Oct 4, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is a sketch of what I propose in #12519 (comment) (cc @jayaddison)
It would need tests and docs (and ideally a deprecation plan) to be merged. Opening as a starter for ten, though.
A