Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove unnecessary utf-8 header in .py files #615

Merged
merged 2 commits into from
Nov 24, 2023

Conversation

samuelorji
Copy link
Contributor

Description

Remove Unnecessary # -*- coding: utf-8 -*- headers from .py files

Issues Resolved

#613

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

codecov bot commented Nov 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5b28423) 71.98% compared to head (b2b8c3e) 71.98%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #615   +/-   ##
=======================================
  Coverage   71.98%   71.98%           
=======================================
  Files          89       89           
  Lines        7935     7935           
=======================================
  Hits         5712     5712           
  Misses       2223     2223           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit, thanks.

CHANGELOG.md Outdated
@@ -10,6 +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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this look like other changelog lines, lowercase unnecessary and add a link to the PR.

@samuelorji samuelorji requested a review from dblock November 24, 2023 20:26
@dblock dblock merged commit 6f26eb3 into opensearch-project:main Nov 24, 2023
56 of 57 checks passed
dblock pushed a commit that referenced this pull request Nov 28, 2023
) (#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]>
roma2023 pushed a commit to roma2023/opensearch-py that referenced this pull request Dec 28, 2023
* remove unnecessary utf-8 header in .py files

Signed-off-by: samuel orji <[email protected]>

* review feedback: add link to changelog

Signed-off-by: samuel orji <[email protected]>

---------

Signed-off-by: samuel orji <[email protected]>
Signed-off-by: roma2023 <[email protected]>
roma2023 pushed a commit to roma2023/opensearch-py that referenced this pull request Dec 28, 2023
…pensearch-project#615) (opensearch-project#617)

* License tools: remove utf-8 coding declaration from license_headers.py check/fix script; since opensearch-project#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]>
Signed-off-by: roma2023 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants