actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Remove unnecessary utf-8 header in license_headers.py (follow-up to #615) (#617)

Browse Source 
* License tools: remove utf-8 coding declaration from license_headers.py check/fix script; since #615 it is no longer used in the library's codebase

UTF-8 is the default encoding used to read source code files for Python3 - see https://docs.python.org/3/howto/unicode.html#unicode-literals-in-python-source-code

Signed-off-by: James Addison <[email protected]>

* Cleanup: remove utf-8 coding declaration from the license_headers.py script itself

Signed-off-by: James Addison <[email protected]>

* Update CHANGELOG.md

Signed-off-by: James Addison <[email protected]>

---------

Signed-off-by: James Addison <[email protected]>
This commit is contained in:
James Addison
2023-11-28 14:00:31 -05:00
committed by GitHub
parent 6f26eb3e8e
commit 0837c5b916
2 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+1 -1
View File
@@ -10,7 +10,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Changed ### Changed
### Deprecated ### Deprecated
### Removed ### Removed
- Removed unnecessary `# -*- coding: utf-8 -*-` headers from .py files ([#615](https://github.com/opensearch-project/opensearch-py/pull/615)) - Removed unnecessary `# -*- coding: utf-8 -*-` headers from .py files ([#615](https://github.com/opensearch-project/opensearch-py/pull/615), [#617](https://github.com/opensearch-project/opensearch-py/pull/617))
### Fixed ### Fixed
### Security ### Security
utils/license_headers.py
+1 -2
View File
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# #
# The OpenSearch Contributors require contributions made to # The OpenSearch Contributors require contributions made to
@@ -18,7 +17,7 @@ import re
import sys import sys
from typing import Iterator, List from typing import Iterator, List
LINES_TO_KEEP = ["# -*- coding: utf-8 -*-", "#!/usr/bin/env python"] LINES_TO_KEEP = ["#!/usr/bin/env python"]
LICENSE_HEADER = """ LICENSE_HEADER = """
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0