add deprecation to docs

asdf-format · Dec 16, 2023 · 50b4ab9 · 50b4ab9
1 parent 4330bd5
commit 50b4ab9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -9,6 +9,9 @@ The ASDF Standard is at v1.6.0
 
 - Deprecate ``asdf.asdf`` and ``AsdfFile.resolve_and_inline`` [#1690]
 
+- Deprecate automatic calling of ``AsdfFile.find_references`` during
+  ``AsdfFile.__init__`` and ``asdf.open`` [#1708]
+
 3.0.1 (2023-10-30)
 ------------------
 

diff --git a/docs/asdf/deprecations.rst b/docs/asdf/deprecations.rst
@@ -16,6 +16,10 @@ Version 3.1
 ``AsdfFile.resolve_references`` and provide ``all_array_storage='inline'`` to
 ``AdsfFile.write_to`` (or ``AsdfFile.update``).
 
+Automatic calling of ``AsdfFile.find_references`` during calls to
+``AsdfFile.__init__`` and ``asdf.open``. Call ``AsdfFile.find_references`` to
+find references.
+
 Version 3.0
 ===========