update docs fix changelog

asdf-format · Nov 16, 2023 · 71e3ba2 · 71e3ba2
1 parent b441d7b
commit 71e3ba2
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,6 +4,14 @@
 The ASDF Standard is at v1.6.0
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+- Deprecate ``asdf.asdf`` [#1690]
+
+3.0.1 (2023-10-30)
+------------------
+
+The ASDF Standard is at v1.6.0
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 - Fix bug in ``asdftool diff`` for arrays within a list [#1672]
 
 3.0.0 (2023-10-16)

diff --git a/asdf/asdf.py b/asdf/asdf.py
@@ -4,7 +4,7 @@
 from .exceptions import AsdfDeprecationWarning
 
 warnings.warn(
-    "asdf.asdf is deprecated",
+    "asdf.asdf is deprecated. Please use asdf.AsdfFile and asdf.open",
     AsdfDeprecationWarning,
 )
 

diff --git a/docs/asdf/deprecations.rst b/docs/asdf/deprecations.rst
@@ -6,6 +6,12 @@
 Deprecations
 ************
 
+Version 3.1
+===========
+
+``asdf.asdf`` is deprecated. Please use the top-level ``asdf`` module for
+``AsdfFile`` and ``open`` (same as ``asdf.asdf.open_asdf``).
+
 Version 3.0
 ===========