From 3174a7854553fe1ffb5cc22534d8169eac3a378c Mon Sep 17 00:00:00 2001 From: EtiennePelletier Date: Mon, 10 May 2021 17:52:11 -0400 Subject: Fix typo (compatability --> compatibility) --- CHANGELOG | 2 +- COMPAT.md | 4 ++-- README.md | 4 ++-- magic/__init__.py | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index fbabad6..b5b6c83 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -5,7 +5,7 @@ Changes to 0.4.21, 0.4.22 Changes to 0.4.20 -- merge in a compatability layer for the upstream libmagic python binding. +- merge in a compatibility layer for the upstream libmagic python binding. Since both this package and that one are called 'magic', this compat layer removes a very common source of runtime errors. Use of that libmagic API will produce a deprecation warning. diff --git a/COMPAT.md b/COMPAT.md index 21b35a1..921abaf 100644 --- a/COMPAT.md +++ b/COMPAT.md @@ -1,10 +1,10 @@ There are two python modules named 'magic' that do the same thing, but with incompatible APIs. One of these ships with libmagic, and (this one) is distributed through pypi. Both have been around for many years and have -substantial user bases. This incompatability is a major source of pain for +substantial user bases. This incompatibility is a major source of pain for users, and bug reports for me. -To mitigate this pain, python-magic has added a compatability layer to export +To mitigate this pain, python-magic has added a compatibility layer to export the libmagic python API parallel to the existing one. The mapping between the libmagic and python-magic functions is: diff --git a/README.md b/README.md index 4c2a507..9eb70e8 100644 --- a/README.md +++ b/README.md @@ -119,9 +119,9 @@ To run against a specific python version: LC_ALL=en_US.UTF-8 python3 test/test.py ``` -## libmagic python API compatability +## libmagic python API compatibility -The python bindings shipped with libmagic use a module name that conflicts with this package. To work around this, python-magic includes a compatability layer for the libmagic API. See [COMPAT.md](COMPAT.md) for a guide to libmagic / python-magic compatability. +The python bindings shipped with libmagic use a module name that conflicts with this package. To work around this, python-magic includes a compatibility layer for the libmagic API. See [COMPAT.md](COMPAT.md) for a guide to libmagic / python-magic compatibility. ## Versioning diff --git a/magic/__init__.py b/magic/__init__.py index 7a75b75..f10a38a 100644 --- a/magic/__init__.py +++ b/magic/__init__.py @@ -420,7 +420,7 @@ def _add_compat(to_module): def deprecation_wrapper(fn): def _(*args, **kwargs): warnings.warn( - "Using compatability mode with libmagic's python binding. " + "Using compatibility mode with libmagic's python binding. " "See https://github.com/ahupp/python-magic/blob/master/COMPAT.md for details.", PendingDeprecationWarning) -- cgit v1.2.1