Skip to content

Commit

Permalink
Hyphenate compound adjectives
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek committed Jul 28, 2022
1 parent 65c0683 commit 696fd78
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.attrs.org/en/latest/names.html>`_ for a more in-depth explanation.

Expand Down
6 changes: 3 additions & 3 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/names.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion tests/test_next_gen.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 696fd78

Please sign in to comment.