diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 2d519dadb..852c62d41 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -940,7 +940,7 @@ Deprecations: This will remove the confusing error message if you write your own ``__init__`` and forget to initialize some attribute. Instead you will get a straightforward ``AttributeError``. In other words: decorated classes will work more like plain Python classes which was always ``attrs``'s goal. -- The serious business aliases ``attr.attributes`` and ``attr.attr`` have been deprecated in favor of ``attr.attrs`` and ``attr.attrib`` which are much more consistent and frankly obvious in hindsight. +- The serious-business aliases ``attr.attributes`` and ``attr.attr`` have been deprecated in favor of ``attr.attrs`` and ``attr.attrib`` which are much more consistent and frankly obvious in hindsight. They will be purged from documentation immediately but there are no plans to actually remove them. diff --git a/README.rst b/README.rst index d10bd3ca4..9f197ea7a 100644 --- a/README.rst +++ b/README.rst @@ -86,7 +86,7 @@ Simply assign ``attrs.field()`` to the attributes instead of annotating them wit ---- This example uses ``attrs``'s modern APIs that have been introduced in version 20.1.0, and the ``attrs`` package import name that has been added in version 21.3.0. -The classic APIs (``@attr.s``, ``attr.ib``, plus their serious business aliases) and the ``attr`` package import name will remain **indefinitely**. +The classic APIs (``@attr.s``, ``attr.ib``, plus their serious-business aliases) and the ``attr`` package import name will remain **indefinitely**. Please check out `On The Core API Names `_ for a more in-depth explanation. diff --git a/docs/api.rst b/docs/api.rst index 37392ee49..a273d19c2 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -124,7 +124,7 @@ Classic .. note:: - ``attrs`` also comes with a serious business alias ``attr.attrs``. + ``attrs`` also comes with a serious-business alias ``attr.attrs``. For example: @@ -164,7 +164,7 @@ Classic .. note:: - ``attrs`` also comes with a serious business alias ``attr.attrib``. + ``attrs`` also comes with a serious-business alias ``attr.attrib``. The object returned by `attr.ib` also allows for setting the default and the validator using decorators: @@ -842,7 +842,7 @@ It behaves similarly to `sys.version_info` and is an instance of `VersionInfo`: ---- -The serious business aliases used to be called ``attr.attributes`` and ``attr.attr``. +The serious-business aliases used to be called ``attr.attributes`` and ``attr.attr``. There are no plans to remove them but they shouldn't be used in new code. .. autofunction:: assoc diff --git a/docs/names.rst b/docs/names.rst index 5aa00afa7..8fb59c306 100644 --- a/docs/names.rst +++ b/docs/names.rst @@ -23,7 +23,7 @@ They are only available in Python 3.6 and later. Sometimes they're referred to as *next-generation* or *NG* APIs. As of ``attrs`` 21.3.0 you can also import them from the ``attrs`` package namespace. -The traditional APIs `attr.s` / `attr.ib`, their serious business aliases ``attr.attrs`` / ``attr.attrib``, and the never-documented, but popular ``attr.dataclass`` easter egg will stay **forever**. +The traditional APIs `attr.s` / `attr.ib`, their serious-business aliases ``attr.attrs`` / ``attr.attrib``, and the never-documented, but popular ``attr.dataclass`` easter egg will stay **forever**. ``attrs`` will **never** force you to use type annotations. diff --git a/tests/test_next_gen.py b/tests/test_next_gen.py index 8395f9c02..1f13de0aa 100644 --- a/tests/test_next_gen.py +++ b/tests/test_next_gen.py @@ -1,7 +1,7 @@ # SPDX-License-Identifier: MIT """ -Python 3-only integration tests for provisional next generation APIs. +Python 3-only integration tests for provisional next-generation APIs. """ import re