Skip to content

Commit

Permalink
Use correct words
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek committed Dec 29, 2021
1 parent 9424a93 commit ce50f40
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Changelog

Versions follow `CalVer <https://calver.org>`_ with a strict backwards-compatibility policy.

The **first digit** of the version is the year.
The **second digit** is incremented with each release, starting at 1 for each year.
The **third digit** is when we need to start branches for older releases (only for emergencies).
The **first number** of the version is the year.
The **second number** is incremented with each release, starting at 1 for each year.
The **third number** is when we need to start branches for older releases (only for emergencies).

Put simply, you shouldn't ever be afraid to upgrade ``attrs`` if you're only using its public APIs.
Whenever there is a need to break compatibility, it is announced here in the changelog, and raises a ``DeprecationWarning`` for a year (if possible) before it's finally really broken.
Expand Down

0 comments on commit ce50f40

Please sign in to comment.