Add docs

python-attrs · Dec 16, 2021 · 9be74a0 · 9be74a0
1 parent 25ab52f
commit 9be74a0
Show file tree

Hide file tree

Showing 18 changed files with 385 additions and 304 deletions.
diff --git a/887.breaking.rst b/887.breaking.rst
@@ -7,3 +7,8 @@ A more elaborate explanation can be found `On The Core API Names <https://www.at
 
 This feature is at least for one release **provisional**.
 We don't *plan* on changing anything, but such a big change is unlikely to go perfectly on the first strike.
+
+The API docs have been mostly updated, but it will be an ongoing effort to change everything to the new APIs.
+Please note that we have **not** moved -- or even removed -- anything from ``attr``!
+
+Please do report any bugs or documentation inconsistencies!
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -12,7 +12,7 @@ Whenever there is a need to break compatibility, it is announced here in the cha
 
 .. warning::
 
-   The structure of the `attr.Attribute` class is exempt from this rule.
+   The structure of the `attrs.Attribute` class is exempt from this rule.
    It *will* change in the future, but since it should be considered read-only, that shouldn't matter.
 
    However if you intend to build extensions on top of ``attrs`` you have to anticipate that.