Skip to content

Commit

Permalink
Remove unnecessary utf-8 header in license_headers.py (follow-up to #615
Browse files Browse the repository at this point in the history
) (#617)

* 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]>
  • Loading branch information
jayaddison authored Nov 28, 2023
1 parent 6f26eb3 commit 0837c5b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Changed
### Deprecated
### 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
### Security

Expand Down
3 changes: 1 addition & 2 deletions utils/license_headers.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
Expand All @@ -18,7 +17,7 @@
import sys
from typing import Iterator, List

LINES_TO_KEEP = ["# -*- coding: utf-8 -*-", "#!/usr/bin/env python"]
LINES_TO_KEEP = ["#!/usr/bin/env python"]

LICENSE_HEADER = """
# SPDX-License-Identifier: Apache-2.0
Expand Down

0 comments on commit 0837c5b

Please sign in to comment.