diff --git a/.github/spellcheck-settings.yml b/.github/spellcheck-settings.yml index 6a08204..df5663b 100644 --- a/.github/spellcheck-settings.yml +++ b/.github/spellcheck-settings.yml @@ -1,7 +1,7 @@ matrix: - name: Markdown expect_match: false - apsell: + aspell: lang: en d: en_US ignore-case: true diff --git a/.github/wordlist.txt b/.github/wordlist.txt index 1f092e2..e32e8b0 100644 --- a/.github/wordlist.txt +++ b/.github/wordlist.txt @@ -30,7 +30,6 @@ boolean customizable dataset de -dedcoded extensibility gcc gevent diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml index 9eefedb..69e7deb 100644 --- a/.github/workflows/integration.yaml +++ b/.github/workflows/integration.yaml @@ -50,10 +50,10 @@ jobs: run: | python setup.py bdist_wheel - # This is a noop job that is only needed for Github settings of the project. - # Github doesn't allow requiring all the checks and instead makes you specify + # This is a noop job that is only needed for GitHub settings of the project. + # GitHub doesn't allow requiring all the checks and instead makes you specify # all the jobs one by one. "run-tests" however is a matrix job and specifying - # all of its possible items is tedious. So we add this job to make Github happy. + # all of its possible items is tedious. So we add this job to make GitHub happy. verify_tests_succeeded: name: Verify that tests succeeded runs-on: ubuntu-latest diff --git a/.github/workflows/pypi-publish.yaml b/.github/workflows/pypi-publish.yaml index 7fab8b3..a41ee9d 100644 --- a/.github/workflows/pypi-publish.yaml +++ b/.github/workflows/pypi-publish.yaml @@ -1,4 +1,4 @@ -name: Publish tag to Pypi +name: Publish tag to PyPI on: release: types: [published] @@ -59,7 +59,7 @@ jobs: path: ./wheelhouse/*.whl publish: - name: Pypi publish + name: PyPI publish needs: ['build_sdist', 'build_wheels'] runs-on: ubuntu-latest environment: pypi @@ -89,5 +89,5 @@ jobs: cp -R artifacts/linux/* dist cp -R artifacts/macos/* dist cp -R artifacts/sdist/* dist - - name: Publish to Pypi + - name: Publish to PyPI uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/CHANGELOG.md b/CHANGELOG.md index f116f1b..7645dff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,7 +31,7 @@ ### 1.0.1 (2019-11-13) * Permit all allowed values of codec errors (see #86) -* BUGFIX: READEME.md has UTF-8 characters, setup.py will fail on systems +* BUGFIX: README.md has UTF-8 characters, setup.py will fail on systems where the locale is not UTF-8. (see #89) ### 1.0.0 (2019-01-20) diff --git a/README.md b/README.md index 0abcf6a..885a4a8 100644 --- a/README.md +++ b/README.md @@ -90,11 +90,9 @@ initializing it: Decoding of bulk data will be attempted using the specified encoding and error handler. If the error handler is `'strict'` (the default), a -`UnicodeDecodeError` is raised when data cannot be dedcoded. This is identical +`UnicodeDecodeError` is raised when data cannot be decoded. This is identical to Python's default behavior. Other valid values to `errors` include -`'replace'`, `'ignore'`, and `'backslashreplace'`. More information on the -behavior of these error handlers can be found -[here](https://docs.python.org/3/howto/unicode.html#the-string-type). +`'replace'`, `'ignore'`, and `'backslashreplace'`. See [Unicode HOWTO: The String Type](https://docs.python.org/3/howto/unicode.html#the-string-type) for more information on the behavior of these error handlers. When the specified encoding cannot be found, a `LookupError` will be raised