diff --git a/docs/asdf/arrays.rst b/docs/asdf/arrays.rst index ba9f79f5c..34c4cbf2e 100644 --- a/docs/asdf/arrays.rst +++ b/docs/asdf/arrays.rst @@ -158,14 +158,15 @@ implicitly determined to include all of the remaining contents of the file. By definition, it must be the last block in the file. To use streaming, rather than including a Numpy array object in the -tree, you include a `asdf.Stream` object which sets up the structure +tree, you include a `asdf.tags.core.Stream` object which sets up the structure of the streamed data, but will not write out the actual content. The file handle's ``write`` method is then used to manually write out the binary data. .. runcode:: - from asdf import AsdfFile, Stream + from asdf import AsdfFile + from asdf.tags.core import Stream import numpy as np tree = { @@ -194,7 +195,8 @@ to numpy arrays stored in ASDF: import csv import numpy as np - from asdf import AsdfFile, Stream + from asdf import AsdfFile + from asdf.tags.core import Stream tree = { # We happen to know in advance that each row in the CSV has 100 ints diff --git a/docs/asdf/deprecations.rst b/docs/asdf/deprecations.rst index ba49497e2..e026f275d 100644 --- a/docs/asdf/deprecations.rst +++ b/docs/asdf/deprecations.rst @@ -66,16 +66,6 @@ Without support for ``fits_embed.AsdfInFits`` the ``extract`` and ``remove-hdu`` commands for :ref:`asdftool ` are no longer usable and are deprecated. -.. _asdffile_blocks_deprecation: - -AsdfFile.blocks Deprecation -=========================== - -Direct usage of the ASDF block manager through `asdf.AsdfFile.blocks` is deprecated. -The BlockManager api was not previously included in the documentation and -was unused by the legacy and new style extensions. Planned features for ASDF 3.0 -include adding block storage support to :ref:`converters `. - .. _tests_helpers_deprecation: asdf.tests.helpers Deprecation diff --git a/docs/asdf/extending/converters.rst b/docs/asdf/extending/converters.rst index ca8627ce4..36fe0dff8 100644 --- a/docs/asdf/extending/converters.rst +++ b/docs/asdf/extending/converters.rst @@ -301,7 +301,7 @@ the index of the block a Converter would like to use to read or write the correc block. However, the index used for reading might not be the same index for writing if the tree was modified or the file is being written to a new location. During serialization and deserialization, asdf will associate each object with the -accessed block during `from_yaml_tree` and `to_yaml_tree`. +accessed block during `Converter.from_yaml_tree` and `Converter.to_yaml_tree`. .. note:: Converters using multiple blocks are slightly more complicated. diff --git a/docs/asdf/user_api.rst b/docs/asdf/user_api.rst index 2b2647eb3..214d3de18 100644 --- a/docs/asdf/user_api.rst +++ b/docs/asdf/user_api.rst @@ -9,6 +9,7 @@ User API :inherited-members: :no-inheritance-diagram: :skip: ValidationError + :skip: Stream .. automodapi:: asdf.search