Update license header and remove UTF-8 header #2001
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
bayliffe
requested changes
May 21, 2024
There was a problem hiding this comment.
- You've used "improver" lower case in the new header, which looks nice, but as it's technically an acronym should we be using upper case? Not too worried, but others might be.
- You've not modified the bin/improver or bin/improver-tests files, which have slightly different license headers, but could still be compressed.
- This documentation
doc/source/Code-Style-Guide.rststill lists the old header as being necessary for all new files. Can you please modify this to match the new header.
Indeed. I wont get away with this 😋
Ah, thanks. I'll take a look.
👍 Thanks for the feedback @bayliffe |
bayliffe
approved these changes
May 21, 2024
2 tasks
Merged
MoseleyS
pushed a commit
to MoseleyS/improver
that referenced
this pull request
Aug 22, 2024
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.
As IAG for science code, I can attest to the fact that the license header needn't be so elaborate.
Furthermore, marking files with a UTF-8 header was more relevant in older versions of Python, specifically before Python 3.0, to ensure correct interpretation of non-ASCII characters. I can't think of a reason why this is included in IMPROVER headers.
(noticed this while adding new files as part of #2000)
Issues